<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.configuration;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.Serializable;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.ArrayList;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.Collection;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.util.Collections;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.Iterator;<a name="line.24"></a>
<FONT color="green">025</FONT>    import java.util.LinkedHashSet;<a name="line.25"></a>
<FONT color="green">026</FONT>    import java.util.LinkedList;<a name="line.26"></a>
<FONT color="green">027</FONT>    import java.util.List;<a name="line.27"></a>
<FONT color="green">028</FONT>    import java.util.Set;<a name="line.28"></a>
<FONT color="green">029</FONT>    import java.util.Stack;<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.commons.configuration.event.ConfigurationEvent;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.commons.configuration.event.ConfigurationListener;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.commons.configuration.tree.ConfigurationNode;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.commons.configuration.tree.ConfigurationNodeVisitorAdapter;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.commons.configuration.tree.DefaultConfigurationNode;<a name="line.35"></a>
<FONT color="green">036</FONT>    import org.apache.commons.configuration.tree.DefaultExpressionEngine;<a name="line.36"></a>
<FONT color="green">037</FONT>    import org.apache.commons.configuration.tree.ExpressionEngine;<a name="line.37"></a>
<FONT color="green">038</FONT>    import org.apache.commons.configuration.tree.NodeAddData;<a name="line.38"></a>
<FONT color="green">039</FONT>    import org.apache.commons.configuration.tree.ViewNode;<a name="line.39"></a>
<FONT color="green">040</FONT>    import org.apache.commons.lang.StringUtils;<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>    /**<a name="line.42"></a>
<FONT color="green">043</FONT>     * &lt;p&gt;A specialized configuration class that extends its base class by the<a name="line.43"></a>
<FONT color="green">044</FONT>     * ability of keeping more structure in the stored properties.&lt;/p&gt;&lt;p&gt;There<a name="line.44"></a>
<FONT color="green">045</FONT>     * are some sources of configuration data that cannot be stored very well in a<a name="line.45"></a>
<FONT color="green">046</FONT>     * {@code BaseConfiguration} object because then their structure is lost.<a name="line.46"></a>
<FONT color="green">047</FONT>     * This is especially true for XML documents. This class can deal with such<a name="line.47"></a>
<FONT color="green">048</FONT>     * structured configuration sources by storing the properties in a tree-like<a name="line.48"></a>
<FONT color="green">049</FONT>     * organization.&lt;/p&gt;&lt;p&gt;The internal used storage form allows for a more<a name="line.49"></a>
<FONT color="green">050</FONT>     * sophisticated access to single properties. As an example consider the<a name="line.50"></a>
<FONT color="green">051</FONT>     * following XML document:&lt;/p&gt;&lt;p&gt;<a name="line.51"></a>
<FONT color="green">052</FONT>     *<a name="line.52"></a>
<FONT color="green">053</FONT>     * &lt;pre&gt;<a name="line.53"></a>
<FONT color="green">054</FONT>     * &amp;lt;database&amp;gt;<a name="line.54"></a>
<FONT color="green">055</FONT>     *   &amp;lt;tables&amp;gt;<a name="line.55"></a>
<FONT color="green">056</FONT>     *     &amp;lt;table&amp;gt;<a name="line.56"></a>
<FONT color="green">057</FONT>     *       &amp;lt;name&amp;gt;users&amp;lt;/name&amp;gt;<a name="line.57"></a>
<FONT color="green">058</FONT>     *       &amp;lt;fields&amp;gt;<a name="line.58"></a>
<FONT color="green">059</FONT>     *         &amp;lt;field&amp;gt;<a name="line.59"></a>
<FONT color="green">060</FONT>     *           &amp;lt;name&amp;gt;lid&amp;lt;/name&amp;gt;<a name="line.60"></a>
<FONT color="green">061</FONT>     *           &amp;lt;type&amp;gt;long&amp;lt;/name&amp;gt;<a name="line.61"></a>
<FONT color="green">062</FONT>     *         &amp;lt;/field&amp;gt;<a name="line.62"></a>
<FONT color="green">063</FONT>     *         &amp;lt;field&amp;gt;<a name="line.63"></a>
<FONT color="green">064</FONT>     *           &amp;lt;name&amp;gt;usrName&amp;lt;/name&amp;gt;<a name="line.64"></a>
<FONT color="green">065</FONT>     *           &amp;lt;type&amp;gt;java.lang.String&amp;lt;/type&amp;gt;<a name="line.65"></a>
<FONT color="green">066</FONT>     *         &amp;lt;/field&amp;gt;<a name="line.66"></a>
<FONT color="green">067</FONT>     *        ...<a name="line.67"></a>
<FONT color="green">068</FONT>     *       &amp;lt;/fields&amp;gt;<a name="line.68"></a>
<FONT color="green">069</FONT>     *     &amp;lt;/table&amp;gt;<a name="line.69"></a>
<FONT color="green">070</FONT>     *     &amp;lt;table&amp;gt;<a name="line.70"></a>
<FONT color="green">071</FONT>     *       &amp;lt;name&amp;gt;documents&amp;lt;/name&amp;gt;<a name="line.71"></a>
<FONT color="green">072</FONT>     *       &amp;lt;fields&amp;gt;<a name="line.72"></a>
<FONT color="green">073</FONT>     *         &amp;lt;field&amp;gt;<a name="line.73"></a>
<FONT color="green">074</FONT>     *           &amp;lt;name&amp;gt;docid&amp;lt;/name&amp;gt;<a name="line.74"></a>
<FONT color="green">075</FONT>     *           &amp;lt;type&amp;gt;long&amp;lt;/type&amp;gt;<a name="line.75"></a>
<FONT color="green">076</FONT>     *         &amp;lt;/field&amp;gt;<a name="line.76"></a>
<FONT color="green">077</FONT>     *         ...<a name="line.77"></a>
<FONT color="green">078</FONT>     *       &amp;lt;/fields&amp;gt;<a name="line.78"></a>
<FONT color="green">079</FONT>     *     &amp;lt;/table&amp;gt;<a name="line.79"></a>
<FONT color="green">080</FONT>     *     ...<a name="line.80"></a>
<FONT color="green">081</FONT>     *   &amp;lt;/tables&amp;gt;<a name="line.81"></a>
<FONT color="green">082</FONT>     * &amp;lt;/database&amp;gt;<a name="line.82"></a>
<FONT color="green">083</FONT>     * &lt;/pre&gt;<a name="line.83"></a>
<FONT color="green">084</FONT>     *<a name="line.84"></a>
<FONT color="green">085</FONT>     * &lt;/p&gt;&lt;p&gt;If this document is parsed and stored in a<a name="line.85"></a>
<FONT color="green">086</FONT>     * {@code HierarchicalConfiguration} object (which can be done by one of<a name="line.86"></a>
<FONT color="green">087</FONT>     * the sub classes), there are enhanced possibilities of accessing properties.<a name="line.87"></a>
<FONT color="green">088</FONT>     * The keys for querying information can contain indices that select a certain<a name="line.88"></a>
<FONT color="green">089</FONT>     * element if there are multiple hits.&lt;/p&gt;&lt;p&gt;For instance the key<a name="line.89"></a>
<FONT color="green">090</FONT>     * {@code tables.table(0).name} can be used to find out the name of the<a name="line.90"></a>
<FONT color="green">091</FONT>     * first table. In opposite {@code tables.table.name} would return a<a name="line.91"></a>
<FONT color="green">092</FONT>     * collection with the names of all available tables. Similarly the key<a name="line.92"></a>
<FONT color="green">093</FONT>     * {@code tables.table(1).fields.field.name} returns a collection with<a name="line.93"></a>
<FONT color="green">094</FONT>     * the names of all fields of the second table. If another index is added after<a name="line.94"></a>
<FONT color="green">095</FONT>     * the {@code field} element, a single field can be accessed:<a name="line.95"></a>
<FONT color="green">096</FONT>     * {@code tables.table(1).fields.field(0).name}.&lt;/p&gt;&lt;p&gt;There is a<a name="line.96"></a>
<FONT color="green">097</FONT>     * {@code getMaxIndex()} method that returns the maximum allowed index<a name="line.97"></a>
<FONT color="green">098</FONT>     * that can be added to a given property key. This method can be used to iterate<a name="line.98"></a>
<FONT color="green">099</FONT>     * over all values defined for a certain property.&lt;/p&gt;<a name="line.99"></a>
<FONT color="green">100</FONT>     * &lt;p&gt;Since the 1.3 release of &lt;em&gt;Commons Configuration&lt;/em&gt; hierarchical<a name="line.100"></a>
<FONT color="green">101</FONT>     * configurations support an &lt;em&gt;expression engine&lt;/em&gt;. This expression engine<a name="line.101"></a>
<FONT color="green">102</FONT>     * is responsible for evaluating the passed in configuration keys and map them<a name="line.102"></a>
<FONT color="green">103</FONT>     * to the stored properties. The examples above are valid for the default<a name="line.103"></a>
<FONT color="green">104</FONT>     * expression engine, which is used when a new {@code HierarchicalConfiguration}<a name="line.104"></a>
<FONT color="green">105</FONT>     * instance is created. With the {@code setExpressionEngine()} method a<a name="line.105"></a>
<FONT color="green">106</FONT>     * different expression engine can be set. For instance with<a name="line.106"></a>
<FONT color="green">107</FONT>     * {@link org.apache.commons.configuration.tree.xpath.XPathExpressionEngine}<a name="line.107"></a>
<FONT color="green">108</FONT>     * there is an expression engine available that supports configuration keys in<a name="line.108"></a>
<FONT color="green">109</FONT>     * XPATH syntax.&lt;/p&gt;<a name="line.109"></a>
<FONT color="green">110</FONT>     * &lt;p&gt;In addition to the events common for all configuration classes hierarchical<a name="line.110"></a>
<FONT color="green">111</FONT>     * configurations support some more events that correspond to some specific<a name="line.111"></a>
<FONT color="green">112</FONT>     * methods and features:<a name="line.112"></a>
<FONT color="green">113</FONT>     * &lt;dl&gt;&lt;dt&gt;&lt;em&gt;EVENT_ADD_NODES&lt;/em&gt;&lt;/dt&gt;&lt;dd&gt;The {@code addNodes()} method<a name="line.113"></a>
<FONT color="green">114</FONT>     * was called; the event object contains the key, to which the nodes were added,<a name="line.114"></a>
<FONT color="green">115</FONT>     * and a collection with the new nodes as value.&lt;/dd&gt;<a name="line.115"></a>
<FONT color="green">116</FONT>     * &lt;dt&gt;&lt;em&gt;EVENT_CLEAR_TREE&lt;/em&gt;&lt;/dt&gt;&lt;dd&gt;The {@code clearTree()} method was<a name="line.116"></a>
<FONT color="green">117</FONT>     * called; the event object stores the key of the removed sub tree.&lt;/dd&gt;<a name="line.117"></a>
<FONT color="green">118</FONT>     * &lt;dt&gt;&lt;em&gt;EVENT_SUBNODE_CHANGED&lt;/em&gt;&lt;/dt&gt;&lt;dd&gt;A {@code SubnodeConfiguration}<a name="line.118"></a>
<FONT color="green">119</FONT>     * that was created from this configuration has been changed. The value property<a name="line.119"></a>
<FONT color="green">120</FONT>     * of the event object contains the original event object as it was sent by the<a name="line.120"></a>
<FONT color="green">121</FONT>     * subnode configuration.&lt;/dd&gt;&lt;/dl&gt;&lt;/p&gt;<a name="line.121"></a>
<FONT color="green">122</FONT>     * &lt;p&gt;&lt;em&gt;Note:&lt;/em&gt;Configuration objects of this type can be read concurrently<a name="line.122"></a>
<FONT color="green">123</FONT>     * by multiple threads. However if one of these threads modifies the object,<a name="line.123"></a>
<FONT color="green">124</FONT>     * synchronization has to be performed manually.&lt;/p&gt;<a name="line.124"></a>
<FONT color="green">125</FONT>     *<a name="line.125"></a>
<FONT color="green">126</FONT>     * @author Oliver Heger<a name="line.126"></a>
<FONT color="green">127</FONT>     * @version $Id: HierarchicalConfiguration.java 1330666 2012-04-26 06:12:30Z oheger $<a name="line.127"></a>
<FONT color="green">128</FONT>     */<a name="line.128"></a>
<FONT color="green">129</FONT>    public class HierarchicalConfiguration extends AbstractConfiguration implements Serializable, Cloneable<a name="line.129"></a>
<FONT color="green">130</FONT>    {<a name="line.130"></a>
<FONT color="green">131</FONT>        /**<a name="line.131"></a>
<FONT color="green">132</FONT>         * Constant for the clear tree event.<a name="line.132"></a>
<FONT color="green">133</FONT>         * @since 1.3<a name="line.133"></a>
<FONT color="green">134</FONT>         */<a name="line.134"></a>
<FONT color="green">135</FONT>        public static final int EVENT_CLEAR_TREE = 10;<a name="line.135"></a>
<FONT color="green">136</FONT>    <a name="line.136"></a>
<FONT color="green">137</FONT>        /**<a name="line.137"></a>
<FONT color="green">138</FONT>         * Constant for the add nodes event.<a name="line.138"></a>
<FONT color="green">139</FONT>         * @since 1.3<a name="line.139"></a>
<FONT color="green">140</FONT>         */<a name="line.140"></a>
<FONT color="green">141</FONT>        public static final int EVENT_ADD_NODES = 11;<a name="line.141"></a>
<FONT color="green">142</FONT>    <a name="line.142"></a>
<FONT color="green">143</FONT>        /**<a name="line.143"></a>
<FONT color="green">144</FONT>         * Constant for the subnode configuration modified event.<a name="line.144"></a>
<FONT color="green">145</FONT>         * @since 1.5<a name="line.145"></a>
<FONT color="green">146</FONT>         */<a name="line.146"></a>
<FONT color="green">147</FONT>        public static final int EVENT_SUBNODE_CHANGED = 12;<a name="line.147"></a>
<FONT color="green">148</FONT>    <a name="line.148"></a>
<FONT color="green">149</FONT>        /**<a name="line.149"></a>
<FONT color="green">150</FONT>         * The serial version UID.<a name="line.150"></a>
<FONT color="green">151</FONT>         */<a name="line.151"></a>
<FONT color="green">152</FONT>        private static final long serialVersionUID = 3373812230395363192L;<a name="line.152"></a>
<FONT color="green">153</FONT>    <a name="line.153"></a>
<FONT color="green">154</FONT>        /** Stores the default expression engine to be used for new objects.*/<a name="line.154"></a>
<FONT color="green">155</FONT>        private static ExpressionEngine defaultExpressionEngine;<a name="line.155"></a>
<FONT color="green">156</FONT>    <a name="line.156"></a>
<FONT color="green">157</FONT>        /** Stores the root node of this configuration. This field is required for<a name="line.157"></a>
<FONT color="green">158</FONT>         * backwards compatibility only.<a name="line.158"></a>
<FONT color="green">159</FONT>         */<a name="line.159"></a>
<FONT color="green">160</FONT>        private Node root;<a name="line.160"></a>
<FONT color="green">161</FONT>    <a name="line.161"></a>
<FONT color="green">162</FONT>        /** Stores the root configuration node.*/<a name="line.162"></a>
<FONT color="green">163</FONT>        private ConfigurationNode rootNode;<a name="line.163"></a>
<FONT color="green">164</FONT>    <a name="line.164"></a>
<FONT color="green">165</FONT>        /** Stores the expression engine for this instance.*/<a name="line.165"></a>
<FONT color="green">166</FONT>        private transient ExpressionEngine expressionEngine;<a name="line.166"></a>
<FONT color="green">167</FONT>    <a name="line.167"></a>
<FONT color="green">168</FONT>        /**<a name="line.168"></a>
<FONT color="green">169</FONT>         * Creates a new instance of {@code HierarchicalConfiguration}.<a name="line.169"></a>
<FONT color="green">170</FONT>         */<a name="line.170"></a>
<FONT color="green">171</FONT>        public HierarchicalConfiguration()<a name="line.171"></a>
<FONT color="green">172</FONT>        {<a name="line.172"></a>
<FONT color="green">173</FONT>            setRootNode(new Node());<a name="line.173"></a>
<FONT color="green">174</FONT>        }<a name="line.174"></a>
<FONT color="green">175</FONT>    <a name="line.175"></a>
<FONT color="green">176</FONT>        /**<a name="line.176"></a>
<FONT color="green">177</FONT>         * Creates a new instance of {@code HierarchicalConfiguration} and<a name="line.177"></a>
<FONT color="green">178</FONT>         * copies all data contained in the specified configuration into the new<a name="line.178"></a>
<FONT color="green">179</FONT>         * one.<a name="line.179"></a>
<FONT color="green">180</FONT>         *<a name="line.180"></a>
<FONT color="green">181</FONT>         * @param c the configuration that is to be copied (if &lt;b&gt;null&lt;/b&gt;, this<a name="line.181"></a>
<FONT color="green">182</FONT>         * constructor will behave like the standard constructor)<a name="line.182"></a>
<FONT color="green">183</FONT>         * @since 1.4<a name="line.183"></a>
<FONT color="green">184</FONT>         */<a name="line.184"></a>
<FONT color="green">185</FONT>        public HierarchicalConfiguration(HierarchicalConfiguration c)<a name="line.185"></a>
<FONT color="green">186</FONT>        {<a name="line.186"></a>
<FONT color="green">187</FONT>            this();<a name="line.187"></a>
<FONT color="green">188</FONT>            if (c != null)<a name="line.188"></a>
<FONT color="green">189</FONT>            {<a name="line.189"></a>
<FONT color="green">190</FONT>                CloneVisitor visitor = new CloneVisitor();<a name="line.190"></a>
<FONT color="green">191</FONT>                c.getRootNode().visit(visitor);<a name="line.191"></a>
<FONT color="green">192</FONT>                setRootNode(visitor.getClone());<a name="line.192"></a>
<FONT color="green">193</FONT>            }<a name="line.193"></a>
<FONT color="green">194</FONT>        }<a name="line.194"></a>
<FONT color="green">195</FONT>    <a name="line.195"></a>
<FONT color="green">196</FONT>        /**<a name="line.196"></a>
<FONT color="green">197</FONT>         * Returns the object to synchronize on a reload. This class is not<a name="line.197"></a>
<FONT color="green">198</FONT>         * reloadable so this object isn't important<a name="line.198"></a>
<FONT color="green">199</FONT>         *<a name="line.199"></a>
<FONT color="green">200</FONT>         * @return the lock object<a name="line.200"></a>
<FONT color="green">201</FONT>         */<a name="line.201"></a>
<FONT color="green">202</FONT>        public Object getReloadLock()<a name="line.202"></a>
<FONT color="green">203</FONT>        {<a name="line.203"></a>
<FONT color="green">204</FONT>            return this;<a name="line.204"></a>
<FONT color="green">205</FONT>        }<a name="line.205"></a>
<FONT color="green">206</FONT>    <a name="line.206"></a>
<FONT color="green">207</FONT>        /**<a name="line.207"></a>
<FONT color="green">208</FONT>         * Returns the root node of this hierarchical configuration. This method<a name="line.208"></a>
<FONT color="green">209</FONT>         * exists for backwards compatibility only. New code should use the<a name="line.209"></a>
<FONT color="green">210</FONT>         * {@link #getRootNode()} method instead, which operates on<a name="line.210"></a>
<FONT color="green">211</FONT>         * the preferred data type {@code ConfigurationNode}.<a name="line.211"></a>
<FONT color="green">212</FONT>         *<a name="line.212"></a>
<FONT color="green">213</FONT>         * @return the root node<a name="line.213"></a>
<FONT color="green">214</FONT>         */<a name="line.214"></a>
<FONT color="green">215</FONT>        public Node getRoot()<a name="line.215"></a>
<FONT color="green">216</FONT>        {<a name="line.216"></a>
<FONT color="green">217</FONT>            if (root == null &amp;&amp; rootNode != null)<a name="line.217"></a>
<FONT color="green">218</FONT>            {<a name="line.218"></a>
<FONT color="green">219</FONT>                // Dynamically create a snapshot of the root node<a name="line.219"></a>
<FONT color="green">220</FONT>                return new Node(rootNode);<a name="line.220"></a>
<FONT color="green">221</FONT>            }<a name="line.221"></a>
<FONT color="green">222</FONT>    <a name="line.222"></a>
<FONT color="green">223</FONT>            return root;<a name="line.223"></a>
<FONT color="green">224</FONT>        }<a name="line.224"></a>
<FONT color="green">225</FONT>    <a name="line.225"></a>
<FONT color="green">226</FONT>        /**<a name="line.226"></a>
<FONT color="green">227</FONT>         * Sets the root node of this hierarchical configuration. This method<a name="line.227"></a>
<FONT color="green">228</FONT>         * exists for backwards compatibility only. New code should use the<a name="line.228"></a>
<FONT color="green">229</FONT>         * {@link #setRootNode(ConfigurationNode)} method instead,<a name="line.229"></a>
<FONT color="green">230</FONT>         * which operates on the preferred data type {@code ConfigurationNode}.<a name="line.230"></a>
<FONT color="green">231</FONT>         *<a name="line.231"></a>
<FONT color="green">232</FONT>         * @param node the root node<a name="line.232"></a>
<FONT color="green">233</FONT>         */<a name="line.233"></a>
<FONT color="green">234</FONT>        public void setRoot(Node node)<a name="line.234"></a>
<FONT color="green">235</FONT>        {<a name="line.235"></a>
<FONT color="green">236</FONT>            if (node == null)<a name="line.236"></a>
<FONT color="green">237</FONT>            {<a name="line.237"></a>
<FONT color="green">238</FONT>                throw new IllegalArgumentException("Root node must not be null!");<a name="line.238"></a>
<FONT color="green">239</FONT>            }<a name="line.239"></a>
<FONT color="green">240</FONT>            root = node;<a name="line.240"></a>
<FONT color="green">241</FONT>            rootNode = null;<a name="line.241"></a>
<FONT color="green">242</FONT>        }<a name="line.242"></a>
<FONT color="green">243</FONT>    <a name="line.243"></a>
<FONT color="green">244</FONT>        /**<a name="line.244"></a>
<FONT color="green">245</FONT>         * Returns the root node of this hierarchical configuration.<a name="line.245"></a>
<FONT color="green">246</FONT>         *<a name="line.246"></a>
<FONT color="green">247</FONT>         * @return the root node<a name="line.247"></a>
<FONT color="green">248</FONT>         * @since 1.3<a name="line.248"></a>
<FONT color="green">249</FONT>         */<a name="line.249"></a>
<FONT color="green">250</FONT>        public ConfigurationNode getRootNode()<a name="line.250"></a>
<FONT color="green">251</FONT>        {<a name="line.251"></a>
<FONT color="green">252</FONT>            return (rootNode != null) ? rootNode : root;<a name="line.252"></a>
<FONT color="green">253</FONT>        }<a name="line.253"></a>
<FONT color="green">254</FONT>    <a name="line.254"></a>
<FONT color="green">255</FONT>        /**<a name="line.255"></a>
<FONT color="green">256</FONT>         * Sets the root node of this hierarchical configuration.<a name="line.256"></a>
<FONT color="green">257</FONT>         *<a name="line.257"></a>
<FONT color="green">258</FONT>         * @param rootNode the root node<a name="line.258"></a>
<FONT color="green">259</FONT>         * @since 1.3<a name="line.259"></a>
<FONT color="green">260</FONT>         */<a name="line.260"></a>
<FONT color="green">261</FONT>        public void setRootNode(ConfigurationNode rootNode)<a name="line.261"></a>
<FONT color="green">262</FONT>        {<a name="line.262"></a>
<FONT color="green">263</FONT>            if (rootNode == null)<a name="line.263"></a>
<FONT color="green">264</FONT>            {<a name="line.264"></a>
<FONT color="green">265</FONT>                throw new IllegalArgumentException("Root node must not be null!");<a name="line.265"></a>
<FONT color="green">266</FONT>            }<a name="line.266"></a>
<FONT color="green">267</FONT>            this.rootNode = rootNode;<a name="line.267"></a>
<FONT color="green">268</FONT>    <a name="line.268"></a>
<FONT color="green">269</FONT>            // For backward compatibility also set the old root field.<a name="line.269"></a>
<FONT color="green">270</FONT>            root = (rootNode instanceof Node) ? (Node) rootNode : null;<a name="line.270"></a>
<FONT color="green">271</FONT>        }<a name="line.271"></a>
<FONT color="green">272</FONT>    <a name="line.272"></a>
<FONT color="green">273</FONT>        /**<a name="line.273"></a>
<FONT color="green">274</FONT>         * Returns the default expression engine.<a name="line.274"></a>
<FONT color="green">275</FONT>         *<a name="line.275"></a>
<FONT color="green">276</FONT>         * @return the default expression engine<a name="line.276"></a>
<FONT color="green">277</FONT>         * @since 1.3<a name="line.277"></a>
<FONT color="green">278</FONT>         */<a name="line.278"></a>
<FONT color="green">279</FONT>        public static synchronized ExpressionEngine getDefaultExpressionEngine()<a name="line.279"></a>
<FONT color="green">280</FONT>        {<a name="line.280"></a>
<FONT color="green">281</FONT>            if (defaultExpressionEngine == null)<a name="line.281"></a>
<FONT color="green">282</FONT>            {<a name="line.282"></a>
<FONT color="green">283</FONT>                defaultExpressionEngine = new DefaultExpressionEngine();<a name="line.283"></a>
<FONT color="green">284</FONT>            }<a name="line.284"></a>
<FONT color="green">285</FONT>            return defaultExpressionEngine;<a name="line.285"></a>
<FONT color="green">286</FONT>        }<a name="line.286"></a>
<FONT color="green">287</FONT>    <a name="line.287"></a>
<FONT color="green">288</FONT>        /**<a name="line.288"></a>
<FONT color="green">289</FONT>         * Sets the default expression engine. This expression engine will be used<a name="line.289"></a>
<FONT color="green">290</FONT>         * if no specific engine was set for an instance. It is shared between all<a name="line.290"></a>
<FONT color="green">291</FONT>         * hierarchical configuration instances. So modifying its properties will<a name="line.291"></a>
<FONT color="green">292</FONT>         * impact all instances, for which no specific engine is set.<a name="line.292"></a>
<FONT color="green">293</FONT>         *<a name="line.293"></a>
<FONT color="green">294</FONT>         * @param engine the new default expression engine<a name="line.294"></a>
<FONT color="green">295</FONT>         * @since 1.3<a name="line.295"></a>
<FONT color="green">296</FONT>         */<a name="line.296"></a>
<FONT color="green">297</FONT>        public static synchronized void setDefaultExpressionEngine(ExpressionEngine engine)<a name="line.297"></a>
<FONT color="green">298</FONT>        {<a name="line.298"></a>
<FONT color="green">299</FONT>            if (engine == null)<a name="line.299"></a>
<FONT color="green">300</FONT>            {<a name="line.300"></a>
<FONT color="green">301</FONT>                throw new IllegalArgumentException(<a name="line.301"></a>
<FONT color="green">302</FONT>                        "Default expression engine must not be null!");<a name="line.302"></a>
<FONT color="green">303</FONT>            }<a name="line.303"></a>
<FONT color="green">304</FONT>            defaultExpressionEngine = engine;<a name="line.304"></a>
<FONT color="green">305</FONT>        }<a name="line.305"></a>
<FONT color="green">306</FONT>    <a name="line.306"></a>
<FONT color="green">307</FONT>        /**<a name="line.307"></a>
<FONT color="green">308</FONT>         * Returns the expression engine used by this configuration. This method<a name="line.308"></a>
<FONT color="green">309</FONT>         * will never return &lt;b&gt;null&lt;/b&gt;; if no specific expression engine was set,<a name="line.309"></a>
<FONT color="green">310</FONT>         * the default expression engine will be returned.<a name="line.310"></a>
<FONT color="green">311</FONT>         *<a name="line.311"></a>
<FONT color="green">312</FONT>         * @return the current expression engine<a name="line.312"></a>
<FONT color="green">313</FONT>         * @since 1.3<a name="line.313"></a>
<FONT color="green">314</FONT>         */<a name="line.314"></a>
<FONT color="green">315</FONT>        public ExpressionEngine getExpressionEngine()<a name="line.315"></a>
<FONT color="green">316</FONT>        {<a name="line.316"></a>
<FONT color="green">317</FONT>            return (expressionEngine != null) ? expressionEngine<a name="line.317"></a>
<FONT color="green">318</FONT>                    : getDefaultExpressionEngine();<a name="line.318"></a>
<FONT color="green">319</FONT>        }<a name="line.319"></a>
<FONT color="green">320</FONT>    <a name="line.320"></a>
<FONT color="green">321</FONT>        /**<a name="line.321"></a>
<FONT color="green">322</FONT>         * Sets the expression engine to be used by this configuration. All property<a name="line.322"></a>
<FONT color="green">323</FONT>         * keys this configuration has to deal with will be interpreted by this<a name="line.323"></a>
<FONT color="green">324</FONT>         * engine.<a name="line.324"></a>
<FONT color="green">325</FONT>         *<a name="line.325"></a>
<FONT color="green">326</FONT>         * @param expressionEngine the new expression engine; can be &lt;b&gt;null&lt;/b&gt;,<a name="line.326"></a>
<FONT color="green">327</FONT>         * then the default expression engine will be used<a name="line.327"></a>
<FONT color="green">328</FONT>         * @since 1.3<a name="line.328"></a>
<FONT color="green">329</FONT>         */<a name="line.329"></a>
<FONT color="green">330</FONT>        public void setExpressionEngine(ExpressionEngine expressionEngine)<a name="line.330"></a>
<FONT color="green">331</FONT>        {<a name="line.331"></a>
<FONT color="green">332</FONT>            this.expressionEngine = expressionEngine;<a name="line.332"></a>
<FONT color="green">333</FONT>        }<a name="line.333"></a>
<FONT color="green">334</FONT>    <a name="line.334"></a>
<FONT color="green">335</FONT>        /**<a name="line.335"></a>
<FONT color="green">336</FONT>         * Fetches the specified property. This task is delegated to the associated<a name="line.336"></a>
<FONT color="green">337</FONT>         * expression engine.<a name="line.337"></a>
<FONT color="green">338</FONT>         *<a name="line.338"></a>
<FONT color="green">339</FONT>         * @param key the key to be looked up<a name="line.339"></a>
<FONT color="green">340</FONT>         * @return the found value<a name="line.340"></a>
<FONT color="green">341</FONT>         */<a name="line.341"></a>
<FONT color="green">342</FONT>        public Object getProperty(String key)<a name="line.342"></a>
<FONT color="green">343</FONT>        {<a name="line.343"></a>
<FONT color="green">344</FONT>            List&lt;ConfigurationNode&gt; nodes = fetchNodeList(key);<a name="line.344"></a>
<FONT color="green">345</FONT>    <a name="line.345"></a>
<FONT color="green">346</FONT>            if (nodes.size() == 0)<a name="line.346"></a>
<FONT color="green">347</FONT>            {<a name="line.347"></a>
<FONT color="green">348</FONT>                return null;<a name="line.348"></a>
<FONT color="green">349</FONT>            }<a name="line.349"></a>
<FONT color="green">350</FONT>            else<a name="line.350"></a>
<FONT color="green">351</FONT>            {<a name="line.351"></a>
<FONT color="green">352</FONT>                List&lt;Object&gt; list = new ArrayList&lt;Object&gt;();<a name="line.352"></a>
<FONT color="green">353</FONT>                for (ConfigurationNode node : nodes)<a name="line.353"></a>
<FONT color="green">354</FONT>                {<a name="line.354"></a>
<FONT color="green">355</FONT>                    if (node.getValue() != null)<a name="line.355"></a>
<FONT color="green">356</FONT>                    {<a name="line.356"></a>
<FONT color="green">357</FONT>                        list.add(node.getValue());<a name="line.357"></a>
<FONT color="green">358</FONT>                    }<a name="line.358"></a>
<FONT color="green">359</FONT>                }<a name="line.359"></a>
<FONT color="green">360</FONT>    <a name="line.360"></a>
<FONT color="green">361</FONT>                if (list.size() &lt; 1)<a name="line.361"></a>
<FONT color="green">362</FONT>                {<a name="line.362"></a>
<FONT color="green">363</FONT>                    return null;<a name="line.363"></a>
<FONT color="green">364</FONT>                }<a name="line.364"></a>
<FONT color="green">365</FONT>                else<a name="line.365"></a>
<FONT color="green">366</FONT>                {<a name="line.366"></a>
<FONT color="green">367</FONT>                    return (list.size() == 1) ? list.get(0) : list;<a name="line.367"></a>
<FONT color="green">368</FONT>                }<a name="line.368"></a>
<FONT color="green">369</FONT>            }<a name="line.369"></a>
<FONT color="green">370</FONT>        }<a name="line.370"></a>
<FONT color="green">371</FONT>    <a name="line.371"></a>
<FONT color="green">372</FONT>        /**<a name="line.372"></a>
<FONT color="green">373</FONT>         * Adds the property with the specified key. This task will be delegated to<a name="line.373"></a>
<FONT color="green">374</FONT>         * the associated {@code ExpressionEngine}, so the passed in key<a name="line.374"></a>
<FONT color="green">375</FONT>         * must match the requirements of this implementation.<a name="line.375"></a>
<FONT color="green">376</FONT>         *<a name="line.376"></a>
<FONT color="green">377</FONT>         * @param key the key of the new property<a name="line.377"></a>
<FONT color="green">378</FONT>         * @param obj the value of the new property<a name="line.378"></a>
<FONT color="green">379</FONT>         */<a name="line.379"></a>
<FONT color="green">380</FONT>        @Override<a name="line.380"></a>
<FONT color="green">381</FONT>        protected void addPropertyDirect(String key, Object obj)<a name="line.381"></a>
<FONT color="green">382</FONT>        {<a name="line.382"></a>
<FONT color="green">383</FONT>            NodeAddData data = getExpressionEngine().prepareAdd(getRootNode(), key);<a name="line.383"></a>
<FONT color="green">384</FONT>            ConfigurationNode node = processNodeAddData(data);<a name="line.384"></a>
<FONT color="green">385</FONT>            node.setValue(obj);<a name="line.385"></a>
<FONT color="green">386</FONT>        }<a name="line.386"></a>
<FONT color="green">387</FONT>    <a name="line.387"></a>
<FONT color="green">388</FONT>        /**<a name="line.388"></a>
<FONT color="green">389</FONT>         * Adds a collection of nodes at the specified position of the configuration<a name="line.389"></a>
<FONT color="green">390</FONT>         * tree. This method works similar to {@code addProperty()}, but<a name="line.390"></a>
<FONT color="green">391</FONT>         * instead of a single property a whole collection of nodes can be added -<a name="line.391"></a>
<FONT color="green">392</FONT>         * and thus complete configuration sub trees. E.g. with this method it is<a name="line.392"></a>
<FONT color="green">393</FONT>         * possible to add parts of another {@code HierarchicalConfiguration}<a name="line.393"></a>
<FONT color="green">394</FONT>         * object to this object. (However be aware that a<a name="line.394"></a>
<FONT color="green">395</FONT>         * {@code ConfigurationNode} object can only belong to a single<a name="line.395"></a>
<FONT color="green">396</FONT>         * configuration. So if nodes from one configuration are directly added to<a name="line.396"></a>
<FONT color="green">397</FONT>         * another one using this method, the structure of the source configuration<a name="line.397"></a>
<FONT color="green">398</FONT>         * will be broken. In this case you should clone the nodes to be added<a name="line.398"></a>
<FONT color="green">399</FONT>         * before calling {@code addNodes()}.) If the passed in key refers to<a name="line.399"></a>
<FONT color="green">400</FONT>         * an existing and unique node, the new nodes are added to this node.<a name="line.400"></a>
<FONT color="green">401</FONT>         * Otherwise a new node will be created at the specified position in the<a name="line.401"></a>
<FONT color="green">402</FONT>         * hierarchy.<a name="line.402"></a>
<FONT color="green">403</FONT>         *<a name="line.403"></a>
<FONT color="green">404</FONT>         * @param key the key where the nodes are to be added; can be &lt;b&gt;null &lt;/b&gt;,<a name="line.404"></a>
<FONT color="green">405</FONT>         * then they are added to the root node<a name="line.405"></a>
<FONT color="green">406</FONT>         * @param nodes a collection with the {@code Node} objects to be<a name="line.406"></a>
<FONT color="green">407</FONT>         * added<a name="line.407"></a>
<FONT color="green">408</FONT>         */<a name="line.408"></a>
<FONT color="green">409</FONT>        public void addNodes(String key, Collection&lt;? extends ConfigurationNode&gt; nodes)<a name="line.409"></a>
<FONT color="green">410</FONT>        {<a name="line.410"></a>
<FONT color="green">411</FONT>            if (nodes == null || nodes.isEmpty())<a name="line.411"></a>
<FONT color="green">412</FONT>            {<a name="line.412"></a>
<FONT color="green">413</FONT>                return;<a name="line.413"></a>
<FONT color="green">414</FONT>            }<a name="line.414"></a>
<FONT color="green">415</FONT>    <a name="line.415"></a>
<FONT color="green">416</FONT>            fireEvent(EVENT_ADD_NODES, key, nodes, true);<a name="line.416"></a>
<FONT color="green">417</FONT>            ConfigurationNode parent;<a name="line.417"></a>
<FONT color="green">418</FONT>            List&lt;ConfigurationNode&gt; target = fetchNodeList(key);<a name="line.418"></a>
<FONT color="green">419</FONT>            if (target.size() == 1)<a name="line.419"></a>
<FONT color="green">420</FONT>            {<a name="line.420"></a>
<FONT color="green">421</FONT>                // existing unique key<a name="line.421"></a>
<FONT color="green">422</FONT>                parent = target.get(0);<a name="line.422"></a>
<FONT color="green">423</FONT>            }<a name="line.423"></a>
<FONT color="green">424</FONT>            else<a name="line.424"></a>
<FONT color="green">425</FONT>            {<a name="line.425"></a>
<FONT color="green">426</FONT>                // otherwise perform an add operation<a name="line.426"></a>
<FONT color="green">427</FONT>                parent = processNodeAddData(getExpressionEngine().prepareAdd(<a name="line.427"></a>
<FONT color="green">428</FONT>                        getRootNode(), key));<a name="line.428"></a>
<FONT color="green">429</FONT>            }<a name="line.429"></a>
<FONT color="green">430</FONT>    <a name="line.430"></a>
<FONT color="green">431</FONT>            if (parent.isAttribute())<a name="line.431"></a>
<FONT color="green">432</FONT>            {<a name="line.432"></a>
<FONT color="green">433</FONT>                throw new IllegalArgumentException(<a name="line.433"></a>
<FONT color="green">434</FONT>                        "Cannot add nodes to an attribute node!");<a name="line.434"></a>
<FONT color="green">435</FONT>            }<a name="line.435"></a>
<FONT color="green">436</FONT>    <a name="line.436"></a>
<FONT color="green">437</FONT>            for (ConfigurationNode child : nodes)<a name="line.437"></a>
<FONT color="green">438</FONT>            {<a name="line.438"></a>
<FONT color="green">439</FONT>                if (child.isAttribute())<a name="line.439"></a>
<FONT color="green">440</FONT>                {<a name="line.440"></a>
<FONT color="green">441</FONT>                    parent.addAttribute(child);<a name="line.441"></a>
<FONT color="green">442</FONT>                }<a name="line.442"></a>
<FONT color="green">443</FONT>                else<a name="line.443"></a>
<FONT color="green">444</FONT>                {<a name="line.444"></a>
<FONT color="green">445</FONT>                    parent.addChild(child);<a name="line.445"></a>
<FONT color="green">446</FONT>                }<a name="line.446"></a>
<FONT color="green">447</FONT>                clearReferences(child);<a name="line.447"></a>
<FONT color="green">448</FONT>            }<a name="line.448"></a>
<FONT color="green">449</FONT>            fireEvent(EVENT_ADD_NODES, key, nodes, false);<a name="line.449"></a>
<FONT color="green">450</FONT>        }<a name="line.450"></a>
<FONT color="green">451</FONT>    <a name="line.451"></a>
<FONT color="green">452</FONT>        /**<a name="line.452"></a>
<FONT color="green">453</FONT>         * Checks if this configuration is empty. Empty means that there are no keys<a name="line.453"></a>
<FONT color="green">454</FONT>         * with any values, though there can be some (empty) nodes.<a name="line.454"></a>
<FONT color="green">455</FONT>         *<a name="line.455"></a>
<FONT color="green">456</FONT>         * @return a flag if this configuration is empty<a name="line.456"></a>
<FONT color="green">457</FONT>         */<a name="line.457"></a>
<FONT color="green">458</FONT>        public boolean isEmpty()<a name="line.458"></a>
<FONT color="green">459</FONT>        {<a name="line.459"></a>
<FONT color="green">460</FONT>            return !nodeDefined(getRootNode());<a name="line.460"></a>
<FONT color="green">461</FONT>        }<a name="line.461"></a>
<FONT color="green">462</FONT>    <a name="line.462"></a>
<FONT color="green">463</FONT>        /**<a name="line.463"></a>
<FONT color="green">464</FONT>         * Creates a new {@code Configuration} object containing all keys<a name="line.464"></a>
<FONT color="green">465</FONT>         * that start with the specified prefix. This implementation will return a<a name="line.465"></a>
<FONT color="green">466</FONT>         * {@code HierarchicalConfiguration} object so that the structure of<a name="line.466"></a>
<FONT color="green">467</FONT>         * the keys will be saved. The nodes selected by the prefix (it is possible<a name="line.467"></a>
<FONT color="green">468</FONT>         * that multiple nodes are selected) are mapped to the root node of the<a name="line.468"></a>
<FONT color="green">469</FONT>         * returned configuration, i.e. their children and attributes will become<a name="line.469"></a>
<FONT color="green">470</FONT>         * children and attributes of the new root node. However a value of the root<a name="line.470"></a>
<FONT color="green">471</FONT>         * node is only set if exactly one of the selected nodes contain a value (if<a name="line.471"></a>
<FONT color="green">472</FONT>         * multiple nodes have a value, there is simply no way to decide how these<a name="line.472"></a>
<FONT color="green">473</FONT>         * values are merged together). Note that the returned<a name="line.473"></a>
<FONT color="green">474</FONT>         * {@code Configuration} object is not connected to its source<a name="line.474"></a>
<FONT color="green">475</FONT>         * configuration: updates on the source configuration are not reflected in<a name="line.475"></a>
<FONT color="green">476</FONT>         * the subset and vice versa.<a name="line.476"></a>
<FONT color="green">477</FONT>         *<a name="line.477"></a>
<FONT color="green">478</FONT>         * @param prefix the prefix of the keys for the subset<a name="line.478"></a>
<FONT color="green">479</FONT>         * @return a new configuration object representing the selected subset<a name="line.479"></a>
<FONT color="green">480</FONT>         */<a name="line.480"></a>
<FONT color="green">481</FONT>        @Override<a name="line.481"></a>
<FONT color="green">482</FONT>        public Configuration subset(String prefix)<a name="line.482"></a>
<FONT color="green">483</FONT>        {<a name="line.483"></a>
<FONT color="green">484</FONT>            Collection&lt;ConfigurationNode&gt; nodes = fetchNodeList(prefix);<a name="line.484"></a>
<FONT color="green">485</FONT>            if (nodes.isEmpty())<a name="line.485"></a>
<FONT color="green">486</FONT>            {<a name="line.486"></a>
<FONT color="green">487</FONT>                return new HierarchicalConfiguration();<a name="line.487"></a>
<FONT color="green">488</FONT>            }<a name="line.488"></a>
<FONT color="green">489</FONT>    <a name="line.489"></a>
<FONT color="green">490</FONT>            final HierarchicalConfiguration parent = this;<a name="line.490"></a>
<FONT color="green">491</FONT>            HierarchicalConfiguration result = new HierarchicalConfiguration()<a name="line.491"></a>
<FONT color="green">492</FONT>            {<a name="line.492"></a>
<FONT color="green">493</FONT>                // Override interpolate to always interpolate on the parent<a name="line.493"></a>
<FONT color="green">494</FONT>                @Override<a name="line.494"></a>
<FONT color="green">495</FONT>                protected Object interpolate(Object value)<a name="line.495"></a>
<FONT color="green">496</FONT>                {<a name="line.496"></a>
<FONT color="green">497</FONT>                    return parent.interpolate(value);<a name="line.497"></a>
<FONT color="green">498</FONT>                }<a name="line.498"></a>
<FONT color="green">499</FONT>            };<a name="line.499"></a>
<FONT color="green">500</FONT>            CloneVisitor visitor = new CloneVisitor();<a name="line.500"></a>
<FONT color="green">501</FONT>    <a name="line.501"></a>
<FONT color="green">502</FONT>            // Initialize the new root node<a name="line.502"></a>
<FONT color="green">503</FONT>            Object value = null;<a name="line.503"></a>
<FONT color="green">504</FONT>            int valueCount = 0;<a name="line.504"></a>
<FONT color="green">505</FONT>            for (ConfigurationNode nd : nodes)<a name="line.505"></a>
<FONT color="green">506</FONT>            {<a name="line.506"></a>
<FONT color="green">507</FONT>                if (nd.getValue() != null)<a name="line.507"></a>
<FONT color="green">508</FONT>                {<a name="line.508"></a>
<FONT color="green">509</FONT>                    value = nd.getValue();<a name="line.509"></a>
<FONT color="green">510</FONT>                    valueCount++;<a name="line.510"></a>
<FONT color="green">511</FONT>                }<a name="line.511"></a>
<FONT color="green">512</FONT>                nd.visit(visitor);<a name="line.512"></a>
<FONT color="green">513</FONT>    <a name="line.513"></a>
<FONT color="green">514</FONT>                for (ConfigurationNode c : visitor.getClone().getChildren())<a name="line.514"></a>
<FONT color="green">515</FONT>                {<a name="line.515"></a>
<FONT color="green">516</FONT>                    result.getRootNode().addChild(c);<a name="line.516"></a>
<FONT color="green">517</FONT>                }<a name="line.517"></a>
<FONT color="green">518</FONT>                for (ConfigurationNode attr : visitor.getClone().getAttributes())<a name="line.518"></a>
<FONT color="green">519</FONT>                {<a name="line.519"></a>
<FONT color="green">520</FONT>                    result.getRootNode().addAttribute(attr);<a name="line.520"></a>
<FONT color="green">521</FONT>                }<a name="line.521"></a>
<FONT color="green">522</FONT>            }<a name="line.522"></a>
<FONT color="green">523</FONT>    <a name="line.523"></a>
<FONT color="green">524</FONT>            // Determine the value of the new root<a name="line.524"></a>
<FONT color="green">525</FONT>            if (valueCount == 1)<a name="line.525"></a>
<FONT color="green">526</FONT>            {<a name="line.526"></a>
<FONT color="green">527</FONT>                result.getRootNode().setValue(value);<a name="line.527"></a>
<FONT color="green">528</FONT>            }<a name="line.528"></a>
<FONT color="green">529</FONT>            return (result.isEmpty()) ? new HierarchicalConfiguration() : result;<a name="line.529"></a>
<FONT color="green">530</FONT>        }<a name="line.530"></a>
<FONT color="green">531</FONT>    <a name="line.531"></a>
<FONT color="green">532</FONT>        /**<a name="line.532"></a>
<FONT color="green">533</FONT>         * &lt;p&gt;<a name="line.533"></a>
<FONT color="green">534</FONT>         * Returns a hierarchical subnode configuration object that wraps the<a name="line.534"></a>
<FONT color="green">535</FONT>         * configuration node specified by the given key. This method provides an<a name="line.535"></a>
<FONT color="green">536</FONT>         * easy means of accessing sub trees of a hierarchical configuration. In the<a name="line.536"></a>
<FONT color="green">537</FONT>         * returned configuration the sub tree can directly be accessed, it becomes<a name="line.537"></a>
<FONT color="green">538</FONT>         * the root node of this configuration. Because of this the passed in key<a name="line.538"></a>
<FONT color="green">539</FONT>         * must select exactly one configuration node; otherwise an<a name="line.539"></a>
<FONT color="green">540</FONT>         * {@code IllegalArgumentException} will be thrown.<a name="line.540"></a>
<FONT color="green">541</FONT>         * &lt;/p&gt;<a name="line.541"></a>
<FONT color="green">542</FONT>         * &lt;p&gt;<a name="line.542"></a>
<FONT color="green">543</FONT>         * The difference between this method and the<a name="line.543"></a>
<FONT color="green">544</FONT>         * {@link #subset(String)} method is that<a name="line.544"></a>
<FONT color="green">545</FONT>         * {@code subset()} supports arbitrary subsets of configuration nodes<a name="line.545"></a>
<FONT color="green">546</FONT>         * while {@code configurationAt()} only returns a single sub tree.<a name="line.546"></a>
<FONT color="green">547</FONT>         * Please refer to the documentation of the<a name="line.547"></a>
<FONT color="green">548</FONT>         * {@code SubnodeConfiguration} class to obtain further information<a name="line.548"></a>
<FONT color="green">549</FONT>         * about subnode configurations and when they should be used.<a name="line.549"></a>
<FONT color="green">550</FONT>         * &lt;/p&gt;<a name="line.550"></a>
<FONT color="green">551</FONT>         * &lt;p&gt;<a name="line.551"></a>
<FONT color="green">552</FONT>         * With the {@code supportUpdate} flag the behavior of the returned<a name="line.552"></a>
<FONT color="green">553</FONT>         * {@code SubnodeConfiguration} regarding updates of its parent<a name="line.553"></a>
<FONT color="green">554</FONT>         * configuration can be determined. A subnode configuration operates on the<a name="line.554"></a>
<FONT color="green">555</FONT>         * same nodes as its parent, so changes at one configuration are normally<a name="line.555"></a>
<FONT color="green">556</FONT>         * directly visible for the other configuration. There are however changes<a name="line.556"></a>
<FONT color="green">557</FONT>         * of the parent configuration, which are not recognized by the subnode<a name="line.557"></a>
<FONT color="green">558</FONT>         * configuration per default. An example for this is a reload operation (for<a name="line.558"></a>
<FONT color="green">559</FONT>         * file-based configurations): Here the complete node set of the parent<a name="line.559"></a>
<FONT color="green">560</FONT>         * configuration is replaced, but the subnode configuration still references<a name="line.560"></a>
<FONT color="green">561</FONT>         * the old nodes. If such changes should be detected by the subnode<a name="line.561"></a>
<FONT color="green">562</FONT>         * configuration, the {@code supportUpdates} flag must be set to<a name="line.562"></a>
<FONT color="green">563</FONT>         * &lt;b&gt;true&lt;/b&gt;. This causes the subnode configuration to reevaluate the key<a name="line.563"></a>
<FONT color="green">564</FONT>         * used for its creation each time it is accessed. This guarantees that the<a name="line.564"></a>
<FONT color="green">565</FONT>         * subnode configuration always stays in sync with its key, even if the<a name="line.565"></a>
<FONT color="green">566</FONT>         * parent configuration's data significantly changes. If such a change<a name="line.566"></a>
<FONT color="green">567</FONT>         * makes the key invalid - because it now no longer points to exactly one<a name="line.567"></a>
<FONT color="green">568</FONT>         * node -, the subnode configuration is not reconstructed, but keeps its<a name="line.568"></a>
<FONT color="green">569</FONT>         * old data. It is then quasi detached from its parent.<a name="line.569"></a>
<FONT color="green">570</FONT>         * &lt;/p&gt;<a name="line.570"></a>
<FONT color="green">571</FONT>         *<a name="line.571"></a>
<FONT color="green">572</FONT>         * @param key the key that selects the sub tree<a name="line.572"></a>
<FONT color="green">573</FONT>         * @param supportUpdates a flag whether the returned subnode configuration<a name="line.573"></a>
<FONT color="green">574</FONT>         * should be able to handle updates of its parent<a name="line.574"></a>
<FONT color="green">575</FONT>         * @return a hierarchical configuration that contains this sub tree<a name="line.575"></a>
<FONT color="green">576</FONT>         * @see SubnodeConfiguration<a name="line.576"></a>
<FONT color="green">577</FONT>         * @since 1.5<a name="line.577"></a>
<FONT color="green">578</FONT>         */<a name="line.578"></a>
<FONT color="green">579</FONT>        public SubnodeConfiguration configurationAt(String key,<a name="line.579"></a>
<FONT color="green">580</FONT>                boolean supportUpdates)<a name="line.580"></a>
<FONT color="green">581</FONT>        {<a name="line.581"></a>
<FONT color="green">582</FONT>            List&lt;ConfigurationNode&gt; nodes = fetchNodeList(key);<a name="line.582"></a>
<FONT color="green">583</FONT>            if (nodes.size() != 1)<a name="line.583"></a>
<FONT color="green">584</FONT>            {<a name="line.584"></a>
<FONT color="green">585</FONT>                throw new IllegalArgumentException(<a name="line.585"></a>
<FONT color="green">586</FONT>                        "Passed in key must select exactly one node: " + key);<a name="line.586"></a>
<FONT color="green">587</FONT>            }<a name="line.587"></a>
<FONT color="green">588</FONT>            return supportUpdates ? createSubnodeConfiguration(<a name="line.588"></a>
<FONT color="green">589</FONT>                    nodes.get(0), key)<a name="line.589"></a>
<FONT color="green">590</FONT>                    : createSubnodeConfiguration(nodes.get(0));<a name="line.590"></a>
<FONT color="green">591</FONT>        }<a name="line.591"></a>
<FONT color="green">592</FONT>    <a name="line.592"></a>
<FONT color="green">593</FONT>        /**<a name="line.593"></a>
<FONT color="green">594</FONT>         * Returns a hierarchical subnode configuration for the node specified by<a name="line.594"></a>
<FONT color="green">595</FONT>         * the given key. This is a short form for {@code configurationAt(key,<a name="line.595"></a>
<FONT color="green">596</FONT>         * &lt;b&gt;false&lt;/b&gt;)}.<a name="line.596"></a>
<FONT color="green">597</FONT>         *<a name="line.597"></a>
<FONT color="green">598</FONT>         * @param key the key that selects the sub tree<a name="line.598"></a>
<FONT color="green">599</FONT>         * @return a hierarchical configuration that contains this sub tree<a name="line.599"></a>
<FONT color="green">600</FONT>         * @see SubnodeConfiguration<a name="line.600"></a>
<FONT color="green">601</FONT>         * @since 1.3<a name="line.601"></a>
<FONT color="green">602</FONT>         */<a name="line.602"></a>
<FONT color="green">603</FONT>        public SubnodeConfiguration configurationAt(String key)<a name="line.603"></a>
<FONT color="green">604</FONT>        {<a name="line.604"></a>
<FONT color="green">605</FONT>            return configurationAt(key, false);<a name="line.605"></a>
<FONT color="green">606</FONT>        }<a name="line.606"></a>
<FONT color="green">607</FONT>    <a name="line.607"></a>
<FONT color="green">608</FONT>        /**<a name="line.608"></a>
<FONT color="green">609</FONT>         * Returns a list of sub configurations for all configuration nodes selected<a name="line.609"></a>
<FONT color="green">610</FONT>         * by the given key. This method will evaluate the passed in key (using the<a name="line.610"></a>
<FONT color="green">611</FONT>         * current {@code ExpressionEngine}) and then create a subnode<a name="line.611"></a>
<FONT color="green">612</FONT>         * configuration for each returned node (like<a name="line.612"></a>
<FONT color="green">613</FONT>         * {@link #configurationAt(String)}}). This is especially<a name="line.613"></a>
<FONT color="green">614</FONT>         * useful when dealing with list-like structures. As an example consider the<a name="line.614"></a>
<FONT color="green">615</FONT>         * configuration that contains data about database tables and their fields.<a name="line.615"></a>
<FONT color="green">616</FONT>         * If you need access to all fields of a certain table, you can simply do<a name="line.616"></a>
<FONT color="green">617</FONT>         *<a name="line.617"></a>
<FONT color="green">618</FONT>         * &lt;pre&gt;<a name="line.618"></a>
<FONT color="green">619</FONT>         * List fields = config.configurationsAt("tables.table(0).fields.field");<a name="line.619"></a>
<FONT color="green">620</FONT>         * for(Iterator it = fields.iterator(); it.hasNext();)<a name="line.620"></a>
<FONT color="green">621</FONT>         * {<a name="line.621"></a>
<FONT color="green">622</FONT>         *     HierarchicalConfiguration sub = (HierarchicalConfiguration) it.next();<a name="line.622"></a>
<FONT color="green">623</FONT>         *     // now the children and attributes of the field node can be<a name="line.623"></a>
<FONT color="green">624</FONT>         *     // directly accessed<a name="line.624"></a>
<FONT color="green">625</FONT>         *     String fieldName = sub.getString("name");<a name="line.625"></a>
<FONT color="green">626</FONT>         *     String fieldType = sub.getString("type");<a name="line.626"></a>
<FONT color="green">627</FONT>         *     ...<a name="line.627"></a>
<FONT color="green">628</FONT>         * &lt;/pre&gt;<a name="line.628"></a>
<FONT color="green">629</FONT>         *<a name="line.629"></a>
<FONT color="green">630</FONT>         * @param key the key for selecting the desired nodes<a name="line.630"></a>
<FONT color="green">631</FONT>         * @return a list with hierarchical configuration objects; each<a name="line.631"></a>
<FONT color="green">632</FONT>         * configuration represents one of the nodes selected by the passed in key<a name="line.632"></a>
<FONT color="green">633</FONT>         * @since 1.3<a name="line.633"></a>
<FONT color="green">634</FONT>         */<a name="line.634"></a>
<FONT color="green">635</FONT>        public List&lt;HierarchicalConfiguration&gt; configurationsAt(String key)<a name="line.635"></a>
<FONT color="green">636</FONT>        {<a name="line.636"></a>
<FONT color="green">637</FONT>            List&lt;ConfigurationNode&gt; nodes = fetchNodeList(key);<a name="line.637"></a>
<FONT color="green">638</FONT>            List&lt;HierarchicalConfiguration&gt; configs = new ArrayList&lt;HierarchicalConfiguration&gt;(nodes.size());<a name="line.638"></a>
<FONT color="green">639</FONT>            for (ConfigurationNode node : nodes)<a name="line.639"></a>
<FONT color="green">640</FONT>            {<a name="line.640"></a>
<FONT color="green">641</FONT>                configs.add(createSubnodeConfiguration(node));<a name="line.641"></a>
<FONT color="green">642</FONT>            }<a name="line.642"></a>
<FONT color="green">643</FONT>            return configs;<a name="line.643"></a>
<FONT color="green">644</FONT>        }<a name="line.644"></a>
<FONT color="green">645</FONT>    <a name="line.645"></a>
<FONT color="green">646</FONT>        /**<a name="line.646"></a>
<FONT color="green">647</FONT>         * Creates a subnode configuration for the specified node. This method is<a name="line.647"></a>
<FONT color="green">648</FONT>         * called by {@code configurationAt()} and<a name="line.648"></a>
<FONT color="green">649</FONT>         * {@code configurationsAt()}.<a name="line.649"></a>
<FONT color="green">650</FONT>         *<a name="line.650"></a>
<FONT color="green">651</FONT>         * @param node the node, for which a subnode configuration is to be created<a name="line.651"></a>
<FONT color="green">652</FONT>         * @return the configuration for the given node<a name="line.652"></a>
<FONT color="green">653</FONT>         * @since 1.3<a name="line.653"></a>
<FONT color="green">654</FONT>         */<a name="line.654"></a>
<FONT color="green">655</FONT>        protected SubnodeConfiguration createSubnodeConfiguration(ConfigurationNode node)<a name="line.655"></a>
<FONT color="green">656</FONT>        {<a name="line.656"></a>
<FONT color="green">657</FONT>            SubnodeConfiguration result = new SubnodeConfiguration(this, node);<a name="line.657"></a>
<FONT color="green">658</FONT>            registerSubnodeConfiguration(result);<a name="line.658"></a>
<FONT color="green">659</FONT>            return result;<a name="line.659"></a>
<FONT color="green">660</FONT>        }<a name="line.660"></a>
<FONT color="green">661</FONT>    <a name="line.661"></a>
<FONT color="green">662</FONT>        /**<a name="line.662"></a>
<FONT color="green">663</FONT>         * Creates a new subnode configuration for the specified node and sets its<a name="line.663"></a>
<FONT color="green">664</FONT>         * construction key. A subnode configuration created this way will be aware<a name="line.664"></a>
<FONT color="green">665</FONT>         * of structural changes of its parent.<a name="line.665"></a>
<FONT color="green">666</FONT>         *<a name="line.666"></a>
<FONT color="green">667</FONT>         * @param node the node, for which a subnode configuration is to be created<a name="line.667"></a>
<FONT color="green">668</FONT>         * @param subnodeKey the key used to construct the configuration<a name="line.668"></a>
<FONT color="green">669</FONT>         * @return the configuration for the given node<a name="line.669"></a>
<FONT color="green">670</FONT>         * @since 1.5<a name="line.670"></a>
<FONT color="green">671</FONT>         */<a name="line.671"></a>
<FONT color="green">672</FONT>        protected SubnodeConfiguration createSubnodeConfiguration(<a name="line.672"></a>
<FONT color="green">673</FONT>                ConfigurationNode node, String subnodeKey)<a name="line.673"></a>
<FONT color="green">674</FONT>        {<a name="line.674"></a>
<FONT color="green">675</FONT>            SubnodeConfiguration result = createSubnodeConfiguration(node);<a name="line.675"></a>
<FONT color="green">676</FONT>            result.setSubnodeKey(subnodeKey);<a name="line.676"></a>
<FONT color="green">677</FONT>            return result;<a name="line.677"></a>
<FONT color="green">678</FONT>        }<a name="line.678"></a>
<FONT color="green">679</FONT>    <a name="line.679"></a>
<FONT color="green">680</FONT>        /**<a name="line.680"></a>
<FONT color="green">681</FONT>         * This method is always called when a subnode configuration created from<a name="line.681"></a>
<FONT color="green">682</FONT>         * this configuration has been modified. This implementation transforms the<a name="line.682"></a>
<FONT color="green">683</FONT>         * received event into an event of type {@code EVENT_SUBNODE_CHANGED}<a name="line.683"></a>
<FONT color="green">684</FONT>         * and notifies the registered listeners.<a name="line.684"></a>
<FONT color="green">685</FONT>         *<a name="line.685"></a>
<FONT color="green">686</FONT>         * @param event the event describing the change<a name="line.686"></a>
<FONT color="green">687</FONT>         * @since 1.5<a name="line.687"></a>
<FONT color="green">688</FONT>         */<a name="line.688"></a>
<FONT color="green">689</FONT>        protected void subnodeConfigurationChanged(ConfigurationEvent event)<a name="line.689"></a>
<FONT color="green">690</FONT>        {<a name="line.690"></a>
<FONT color="green">691</FONT>            fireEvent(EVENT_SUBNODE_CHANGED, null, event, event.isBeforeUpdate());<a name="line.691"></a>
<FONT color="green">692</FONT>        }<a name="line.692"></a>
<FONT color="green">693</FONT>    <a name="line.693"></a>
<FONT color="green">694</FONT>        /**<a name="line.694"></a>
<FONT color="green">695</FONT>         * Registers this instance at the given subnode configuration. This<a name="line.695"></a>
<FONT color="green">696</FONT>         * implementation will register a change listener, so that modifications of<a name="line.696"></a>
<FONT color="green">697</FONT>         * the subnode configuration can be tracked.<a name="line.697"></a>
<FONT color="green">698</FONT>         *<a name="line.698"></a>
<FONT color="green">699</FONT>         * @param config the subnode configuration<a name="line.699"></a>
<FONT color="green">700</FONT>         * @since 1.5<a name="line.700"></a>
<FONT color="green">701</FONT>         */<a name="line.701"></a>
<FONT color="green">702</FONT>        void registerSubnodeConfiguration(SubnodeConfiguration config)<a name="line.702"></a>
<FONT color="green">703</FONT>        {<a name="line.703"></a>
<FONT color="green">704</FONT>            config.addConfigurationListener(new ConfigurationListener()<a name="line.704"></a>
<FONT color="green">705</FONT>            {<a name="line.705"></a>
<FONT color="green">706</FONT>                public void configurationChanged(ConfigurationEvent event)<a name="line.706"></a>
<FONT color="green">707</FONT>                {<a name="line.707"></a>
<FONT color="green">708</FONT>                    subnodeConfigurationChanged(event);<a name="line.708"></a>
<FONT color="green">709</FONT>                }<a name="line.709"></a>
<FONT color="green">710</FONT>            });<a name="line.710"></a>
<FONT color="green">711</FONT>        }<a name="line.711"></a>
<FONT color="green">712</FONT>    <a name="line.712"></a>
<FONT color="green">713</FONT>        /**<a name="line.713"></a>
<FONT color="green">714</FONT>         * Checks if the specified key is contained in this configuration. Note that<a name="line.714"></a>
<FONT color="green">715</FONT>         * for this configuration the term &amp;quot;contained&amp;quot; means that the key<a name="line.715"></a>
<FONT color="green">716</FONT>         * has an associated value. If there is a node for this key that has no<a name="line.716"></a>
<FONT color="green">717</FONT>         * value but children (either defined or undefined), this method will still<a name="line.717"></a>
<FONT color="green">718</FONT>         * return &lt;b&gt;false &lt;/b&gt;.<a name="line.718"></a>
<FONT color="green">719</FONT>         *<a name="line.719"></a>
<FONT color="green">720</FONT>         * @param key the key to be chekced<a name="line.720"></a>
<FONT color="green">721</FONT>         * @return a flag if this key is contained in this configuration<a name="line.721"></a>
<FONT color="green">722</FONT>         */<a name="line.722"></a>
<FONT color="green">723</FONT>        public boolean containsKey(String key)<a name="line.723"></a>
<FONT color="green">724</FONT>        {<a name="line.724"></a>
<FONT color="green">725</FONT>            return getProperty(key) != null;<a name="line.725"></a>
<FONT color="green">726</FONT>        }<a name="line.726"></a>
<FONT color="green">727</FONT>    <a name="line.727"></a>
<FONT color="green">728</FONT>        /**<a name="line.728"></a>
<FONT color="green">729</FONT>         * Sets the value of the specified property.<a name="line.729"></a>
<FONT color="green">730</FONT>         *<a name="line.730"></a>
<FONT color="green">731</FONT>         * @param key the key of the property to set<a name="line.731"></a>
<FONT color="green">732</FONT>         * @param value the new value of this property<a name="line.732"></a>
<FONT color="green">733</FONT>         */<a name="line.733"></a>
<FONT color="green">734</FONT>        @Override<a name="line.734"></a>
<FONT color="green">735</FONT>        public void setProperty(String key, Object value)<a name="line.735"></a>
<FONT color="green">736</FONT>        {<a name="line.736"></a>
<FONT color="green">737</FONT>            fireEvent(EVENT_SET_PROPERTY, key, value, true);<a name="line.737"></a>
<FONT color="green">738</FONT>    <a name="line.738"></a>
<FONT color="green">739</FONT>            // Update the existing nodes for this property<a name="line.739"></a>
<FONT color="green">740</FONT>            Iterator&lt;ConfigurationNode&gt; itNodes = fetchNodeList(key).iterator();<a name="line.740"></a>
<FONT color="green">741</FONT>            Iterator&lt;?&gt; itValues;<a name="line.741"></a>
<FONT color="green">742</FONT>            if (!isDelimiterParsingDisabled() || !(value instanceof String))<a name="line.742"></a>
<FONT color="green">743</FONT>            {<a name="line.743"></a>
<FONT color="green">744</FONT>                itValues = PropertyConverter.toIterator(value, getListDelimiter());<a name="line.744"></a>
<FONT color="green">745</FONT>            }<a name="line.745"></a>
<FONT color="green">746</FONT>            else<a name="line.746"></a>
<FONT color="green">747</FONT>            {<a name="line.747"></a>
<FONT color="green">748</FONT>                itValues = Collections.singleton(value).iterator();<a name="line.748"></a>
<FONT color="green">749</FONT>            }<a name="line.749"></a>
<FONT color="green">750</FONT>    <a name="line.750"></a>
<FONT color="green">751</FONT>            while (itNodes.hasNext() &amp;&amp; itValues.hasNext())<a name="line.751"></a>
<FONT color="green">752</FONT>            {<a name="line.752"></a>
<FONT color="green">753</FONT>                itNodes.next().setValue(itValues.next());<a name="line.753"></a>
<FONT color="green">754</FONT>            }<a name="line.754"></a>
<FONT color="green">755</FONT>    <a name="line.755"></a>
<FONT color="green">756</FONT>            // Add additional nodes if necessary<a name="line.756"></a>
<FONT color="green">757</FONT>            while (itValues.hasNext())<a name="line.757"></a>
<FONT color="green">758</FONT>            {<a name="line.758"></a>
<FONT color="green">759</FONT>                addPropertyDirect(key, itValues.next());<a name="line.759"></a>
<FONT color="green">760</FONT>            }<a name="line.760"></a>
<FONT color="green">761</FONT>    <a name="line.761"></a>
<FONT color="green">762</FONT>            // Remove remaining nodes<a name="line.762"></a>
<FONT color="green">763</FONT>            while (itNodes.hasNext())<a name="line.763"></a>
<FONT color="green">764</FONT>            {<a name="line.764"></a>
<FONT color="green">765</FONT>                clearNode(itNodes.next());<a name="line.765"></a>
<FONT color="green">766</FONT>            }<a name="line.766"></a>
<FONT color="green">767</FONT>    <a name="line.767"></a>
<FONT color="green">768</FONT>            fireEvent(EVENT_SET_PROPERTY, key, value, false);<a name="line.768"></a>
<FONT color="green">769</FONT>        }<a name="line.769"></a>
<FONT color="green">770</FONT>    <a name="line.770"></a>
<FONT color="green">771</FONT>        /**<a name="line.771"></a>
<FONT color="green">772</FONT>         * Clears this configuration. This is a more efficient implementation than<a name="line.772"></a>
<FONT color="green">773</FONT>         * the one inherited from the base class. It directly removes all data from<a name="line.773"></a>
<FONT color="green">774</FONT>         * the root node.<a name="line.774"></a>
<FONT color="green">775</FONT>         */<a name="line.775"></a>
<FONT color="green">776</FONT>        @Override<a name="line.776"></a>
<FONT color="green">777</FONT>        public void clear()<a name="line.777"></a>
<FONT color="green">778</FONT>        {<a name="line.778"></a>
<FONT color="green">779</FONT>            fireEvent(EVENT_CLEAR, null, null, true);<a name="line.779"></a>
<FONT color="green">780</FONT>            getRootNode().removeAttributes();<a name="line.780"></a>
<FONT color="green">781</FONT>            getRootNode().removeChildren();<a name="line.781"></a>
<FONT color="green">782</FONT>            getRootNode().setValue(null);<a name="line.782"></a>
<FONT color="green">783</FONT>            fireEvent(EVENT_CLEAR, null, null, false);<a name="line.783"></a>
<FONT color="green">784</FONT>        }<a name="line.784"></a>
<FONT color="green">785</FONT>    <a name="line.785"></a>
<FONT color="green">786</FONT>        /**<a name="line.786"></a>
<FONT color="green">787</FONT>         * Removes all values of the property with the given name and of keys that<a name="line.787"></a>
<FONT color="green">788</FONT>         * start with this name. So if there is a property with the key<a name="line.788"></a>
<FONT color="green">789</FONT>         * &amp;quot;foo&amp;quot; and a property with the key &amp;quot;foo.bar&amp;quot;, a call<a name="line.789"></a>
<FONT color="green">790</FONT>         * of {@code clearTree("foo")} would remove both properties.<a name="line.790"></a>
<FONT color="green">791</FONT>         *<a name="line.791"></a>
<FONT color="green">792</FONT>         * @param key the key of the property to be removed<a name="line.792"></a>
<FONT color="green">793</FONT>         */<a name="line.793"></a>
<FONT color="green">794</FONT>        public void clearTree(String key)<a name="line.794"></a>
<FONT color="green">795</FONT>        {<a name="line.795"></a>
<FONT color="green">796</FONT>            fireEvent(EVENT_CLEAR_TREE, key, null, true);<a name="line.796"></a>
<FONT color="green">797</FONT>            List&lt;ConfigurationNode&gt; nodes = fetchNodeList(key);<a name="line.797"></a>
<FONT color="green">798</FONT>    <a name="line.798"></a>
<FONT color="green">799</FONT>            for (ConfigurationNode node : nodes)<a name="line.799"></a>
<FONT color="green">800</FONT>            {<a name="line.800"></a>
<FONT color="green">801</FONT>                removeNode(node);<a name="line.801"></a>
<FONT color="green">802</FONT>            }<a name="line.802"></a>
<FONT color="green">803</FONT>            fireEvent(EVENT_CLEAR_TREE, key, nodes, false);<a name="line.803"></a>
<FONT color="green">804</FONT>        }<a name="line.804"></a>
<FONT color="green">805</FONT>    <a name="line.805"></a>
<FONT color="green">806</FONT>        /**<a name="line.806"></a>
<FONT color="green">807</FONT>         * Removes the property with the given key. Properties with names that start<a name="line.807"></a>
<FONT color="green">808</FONT>         * with the given key (i.e. properties below the specified key in the<a name="line.808"></a>
<FONT color="green">809</FONT>         * hierarchy) won't be affected.<a name="line.809"></a>
<FONT color="green">810</FONT>         *<a name="line.810"></a>
<FONT color="green">811</FONT>         * @param key the key of the property to be removed<a name="line.811"></a>
<FONT color="green">812</FONT>         */<a name="line.812"></a>
<FONT color="green">813</FONT>        @Override<a name="line.813"></a>
<FONT color="green">814</FONT>        public void clearProperty(String key)<a name="line.814"></a>
<FONT color="green">815</FONT>        {<a name="line.815"></a>
<FONT color="green">816</FONT>            fireEvent(EVENT_CLEAR_PROPERTY, key, null, true);<a name="line.816"></a>
<FONT color="green">817</FONT>            List&lt;ConfigurationNode&gt; nodes = fetchNodeList(key);<a name="line.817"></a>
<FONT color="green">818</FONT>    <a name="line.818"></a>
<FONT color="green">819</FONT>            for (ConfigurationNode node : nodes)<a name="line.819"></a>
<FONT color="green">820</FONT>            {<a name="line.820"></a>
<FONT color="green">821</FONT>                clearNode(node);<a name="line.821"></a>
<FONT color="green">822</FONT>            }<a name="line.822"></a>
<FONT color="green">823</FONT>    <a name="line.823"></a>
<FONT color="green">824</FONT>            fireEvent(EVENT_CLEAR_PROPERTY, key, null, false);<a name="line.824"></a>
<FONT color="green">825</FONT>        }<a name="line.825"></a>
<FONT color="green">826</FONT>    <a name="line.826"></a>
<FONT color="green">827</FONT>        /**<a name="line.827"></a>
<FONT color="green">828</FONT>         * Returns an iterator with all keys defined in this configuration.<a name="line.828"></a>
<FONT color="green">829</FONT>         * Note that the keys returned by this method will not contain any<a name="line.829"></a>
<FONT color="green">830</FONT>         * indices. This means that some structure will be lost.&lt;/p&gt;<a name="line.830"></a>
<FONT color="green">831</FONT>         *<a name="line.831"></a>
<FONT color="green">832</FONT>         * @return an iterator with the defined keys in this configuration<a name="line.832"></a>
<FONT color="green">833</FONT>         */<a name="line.833"></a>
<FONT color="green">834</FONT>        public Iterator&lt;String&gt; getKeys()<a name="line.834"></a>
<FONT color="green">835</FONT>        {<a name="line.835"></a>
<FONT color="green">836</FONT>            DefinedKeysVisitor visitor = new DefinedKeysVisitor();<a name="line.836"></a>
<FONT color="green">837</FONT>            getRootNode().visit(visitor);<a name="line.837"></a>
<FONT color="green">838</FONT>    <a name="line.838"></a>
<FONT color="green">839</FONT>            return visitor.getKeyList().iterator();<a name="line.839"></a>
<FONT color="green">840</FONT>        }<a name="line.840"></a>
<FONT color="green">841</FONT>    <a name="line.841"></a>
<FONT color="green">842</FONT>        /**<a name="line.842"></a>
<FONT color="green">843</FONT>         * Returns an iterator with all keys defined in this configuration that<a name="line.843"></a>
<FONT color="green">844</FONT>         * start with the given prefix. The returned keys will not contain any<a name="line.844"></a>
<FONT color="green">845</FONT>         * indices. This implementation tries to locate a node whose key is the same<a name="line.845"></a>
<FONT color="green">846</FONT>         * as the passed in prefix. Then the subtree of this node is traversed, and<a name="line.846"></a>
<FONT color="green">847</FONT>         * the keys of all nodes encountered (including attributes) are added to the<a name="line.847"></a>
<FONT color="green">848</FONT>         * result set.<a name="line.848"></a>
<FONT color="green">849</FONT>         *<a name="line.849"></a>
<FONT color="green">850</FONT>         * @param prefix the prefix of the keys to start with<a name="line.850"></a>
<FONT color="green">851</FONT>         * @return an iterator with the found keys<a name="line.851"></a>
<FONT color="green">852</FONT>         */<a name="line.852"></a>
<FONT color="green">853</FONT>        @Override<a name="line.853"></a>
<FONT color="green">854</FONT>        public Iterator&lt;String&gt; getKeys(String prefix)<a name="line.854"></a>
<FONT color="green">855</FONT>        {<a name="line.855"></a>
<FONT color="green">856</FONT>            DefinedKeysVisitor visitor = new DefinedKeysVisitor(prefix);<a name="line.856"></a>
<FONT color="green">857</FONT>            if (containsKey(prefix))<a name="line.857"></a>
<FONT color="green">858</FONT>            {<a name="line.858"></a>
<FONT color="green">859</FONT>                // explicitly add the prefix<a name="line.859"></a>
<FONT color="green">860</FONT>                visitor.getKeyList().add(prefix);<a name="line.860"></a>
<FONT color="green">861</FONT>            }<a name="line.861"></a>
<FONT color="green">862</FONT>    <a name="line.862"></a>
<FONT color="green">863</FONT>            List&lt;ConfigurationNode&gt; nodes = fetchNodeList(prefix);<a name="line.863"></a>
<FONT color="green">864</FONT>    <a name="line.864"></a>
<FONT color="green">865</FONT>            for (ConfigurationNode node : nodes)<a name="line.865"></a>
<FONT color="green">866</FONT>            {<a name="line.866"></a>
<FONT color="green">867</FONT>                for (ConfigurationNode c : node.getChildren())<a name="line.867"></a>
<FONT color="green">868</FONT>                {<a name="line.868"></a>
<FONT color="green">869</FONT>                    c.visit(visitor);<a name="line.869"></a>
<FONT color="green">870</FONT>                }<a name="line.870"></a>
<FONT color="green">871</FONT>                for (ConfigurationNode attr : node.getAttributes())<a name="line.871"></a>
<FONT color="green">872</FONT>                {<a name="line.872"></a>
<FONT color="green">873</FONT>                    attr.visit(visitor);<a name="line.873"></a>
<FONT color="green">874</FONT>                }<a name="line.874"></a>
<FONT color="green">875</FONT>            }<a name="line.875"></a>
<FONT color="green">876</FONT>    <a name="line.876"></a>
<FONT color="green">877</FONT>            return visitor.getKeyList().iterator();<a name="line.877"></a>
<FONT color="green">878</FONT>        }<a name="line.878"></a>
<FONT color="green">879</FONT>    <a name="line.879"></a>
<FONT color="green">880</FONT>        /**<a name="line.880"></a>
<FONT color="green">881</FONT>         * Returns the maximum defined index for the given key. This is useful if<a name="line.881"></a>
<FONT color="green">882</FONT>         * there are multiple values for this key. They can then be addressed<a name="line.882"></a>
<FONT color="green">883</FONT>         * separately by specifying indices from 0 to the return value of this<a name="line.883"></a>
<FONT color="green">884</FONT>         * method.<a name="line.884"></a>
<FONT color="green">885</FONT>         *<a name="line.885"></a>
<FONT color="green">886</FONT>         * @param key the key to be checked<a name="line.886"></a>
<FONT color="green">887</FONT>         * @return the maximum defined index for this key<a name="line.887"></a>
<FONT color="green">888</FONT>         */<a name="line.888"></a>
<FONT color="green">889</FONT>        public int getMaxIndex(String key)<a name="line.889"></a>
<FONT color="green">890</FONT>        {<a name="line.890"></a>
<FONT color="green">891</FONT>            return fetchNodeList(key).size() - 1;<a name="line.891"></a>
<FONT color="green">892</FONT>        }<a name="line.892"></a>
<FONT color="green">893</FONT>    <a name="line.893"></a>
<FONT color="green">894</FONT>        /**<a name="line.894"></a>
<FONT color="green">895</FONT>         * Creates a copy of this object. This new configuration object will contain<a name="line.895"></a>
<FONT color="green">896</FONT>         * copies of all nodes in the same structure. Registered event listeners<a name="line.896"></a>
<FONT color="green">897</FONT>         * won't be cloned; so they are not registered at the returned copy.<a name="line.897"></a>
<FONT color="green">898</FONT>         *<a name="line.898"></a>
<FONT color="green">899</FONT>         * @return the copy<a name="line.899"></a>
<FONT color="green">900</FONT>         * @since 1.2<a name="line.900"></a>
<FONT color="green">901</FONT>         */<a name="line.901"></a>
<FONT color="green">902</FONT>        @Override<a name="line.902"></a>
<FONT color="green">903</FONT>        public Object clone()<a name="line.903"></a>
<FONT color="green">904</FONT>        {<a name="line.904"></a>
<FONT color="green">905</FONT>            try<a name="line.905"></a>
<FONT color="green">906</FONT>            {<a name="line.906"></a>
<FONT color="green">907</FONT>                HierarchicalConfiguration copy = (HierarchicalConfiguration) super<a name="line.907"></a>
<FONT color="green">908</FONT>                        .clone();<a name="line.908"></a>
<FONT color="green">909</FONT>    <a name="line.909"></a>
<FONT color="green">910</FONT>                // clone the nodes, too<a name="line.910"></a>
<FONT color="green">911</FONT>                CloneVisitor v = new CloneVisitor();<a name="line.911"></a>
<FONT color="green">912</FONT>                getRootNode().visit(v);<a name="line.912"></a>
<FONT color="green">913</FONT>                copy.setRootNode(v.getClone());<a name="line.913"></a>
<FONT color="green">914</FONT>    <a name="line.914"></a>
<FONT color="green">915</FONT>                return copy;<a name="line.915"></a>
<FONT color="green">916</FONT>            }<a name="line.916"></a>
<FONT color="green">917</FONT>            catch (CloneNotSupportedException cex)<a name="line.917"></a>
<FONT color="green">918</FONT>            {<a name="line.918"></a>
<FONT color="green">919</FONT>                // should not happen<a name="line.919"></a>
<FONT color="green">920</FONT>                throw new ConfigurationRuntimeException(cex);<a name="line.920"></a>
<FONT color="green">921</FONT>            }<a name="line.921"></a>
<FONT color="green">922</FONT>        }<a name="line.922"></a>
<FONT color="green">923</FONT>    <a name="line.923"></a>
<FONT color="green">924</FONT>        /**<a name="line.924"></a>
<FONT color="green">925</FONT>         * Returns a configuration with the same content as this configuration, but<a name="line.925"></a>
<FONT color="green">926</FONT>         * with all variables replaced by their actual values. This implementation<a name="line.926"></a>
<FONT color="green">927</FONT>         * is specific for hierarchical configurations. It clones the current<a name="line.927"></a>
<FONT color="green">928</FONT>         * configuration and runs a specialized visitor on the clone, which performs<a name="line.928"></a>
<FONT color="green">929</FONT>         * interpolation on the single configuration nodes.<a name="line.929"></a>
<FONT color="green">930</FONT>         *<a name="line.930"></a>
<FONT color="green">931</FONT>         * @return a configuration with all variables interpolated<a name="line.931"></a>
<FONT color="green">932</FONT>         * @since 1.5<a name="line.932"></a>
<FONT color="green">933</FONT>         */<a name="line.933"></a>
<FONT color="green">934</FONT>        @Override<a name="line.934"></a>
<FONT color="green">935</FONT>        public Configuration interpolatedConfiguration()<a name="line.935"></a>
<FONT color="green">936</FONT>        {<a name="line.936"></a>
<FONT color="green">937</FONT>            HierarchicalConfiguration c = (HierarchicalConfiguration) clone();<a name="line.937"></a>
<FONT color="green">938</FONT>            c.getRootNode().visit(new ConfigurationNodeVisitorAdapter()<a name="line.938"></a>
<FONT color="green">939</FONT>            {<a name="line.939"></a>
<FONT color="green">940</FONT>                @Override<a name="line.940"></a>
<FONT color="green">941</FONT>                public void visitAfterChildren(ConfigurationNode node)<a name="line.941"></a>
<FONT color="green">942</FONT>                {<a name="line.942"></a>
<FONT color="green">943</FONT>                    node.setValue(interpolate(node.getValue()));<a name="line.943"></a>
<FONT color="green">944</FONT>                }<a name="line.944"></a>
<FONT color="green">945</FONT>            });<a name="line.945"></a>
<FONT color="green">946</FONT>            return c;<a name="line.946"></a>
<FONT color="green">947</FONT>        }<a name="line.947"></a>
<FONT color="green">948</FONT>    <a name="line.948"></a>
<FONT color="green">949</FONT>        /**<a name="line.949"></a>
<FONT color="green">950</FONT>         * Helper method for fetching a list of all nodes that are addressed by the<a name="line.950"></a>
<FONT color="green">951</FONT>         * specified key.<a name="line.951"></a>
<FONT color="green">952</FONT>         *<a name="line.952"></a>
<FONT color="green">953</FONT>         * @param key the key<a name="line.953"></a>
<FONT color="green">954</FONT>         * @return a list with all affected nodes (never &lt;b&gt;null &lt;/b&gt;)<a name="line.954"></a>
<FONT color="green">955</FONT>         */<a name="line.955"></a>
<FONT color="green">956</FONT>        protected List&lt;ConfigurationNode&gt; fetchNodeList(String key)<a name="line.956"></a>
<FONT color="green">957</FONT>        {<a name="line.957"></a>
<FONT color="green">958</FONT>            return getExpressionEngine().query(getRootNode(), key);<a name="line.958"></a>
<FONT color="green">959</FONT>        }<a name="line.959"></a>
<FONT color="green">960</FONT>    <a name="line.960"></a>
<FONT color="green">961</FONT>        /**<a name="line.961"></a>
<FONT color="green">962</FONT>         * Recursive helper method for fetching a property. This method processes<a name="line.962"></a>
<FONT color="green">963</FONT>         * all facets of a configuration key, traverses the tree of properties and<a name="line.963"></a>
<FONT color="green">964</FONT>         * fetches the the nodes of all matching properties.<a name="line.964"></a>
<FONT color="green">965</FONT>         *<a name="line.965"></a>
<FONT color="green">966</FONT>         * @param keyPart the configuration key iterator<a name="line.966"></a>
<FONT color="green">967</FONT>         * @param node the actual node<a name="line.967"></a>
<FONT color="green">968</FONT>         * @param nodes here the found nodes are stored<a name="line.968"></a>
<FONT color="green">969</FONT>         * @deprecated Property keys are now evaluated by the expression engine<a name="line.969"></a>
<FONT color="green">970</FONT>         * associated with the configuration; this method will no longer be called.<a name="line.970"></a>
<FONT color="green">971</FONT>         * If you want to modify the way properties are looked up, consider<a name="line.971"></a>
<FONT color="green">972</FONT>         * implementing you own {@code ExpressionEngine} implementation.<a name="line.972"></a>
<FONT color="green">973</FONT>         */<a name="line.973"></a>
<FONT color="green">974</FONT>        @Deprecated<a name="line.974"></a>
<FONT color="green">975</FONT>        protected void findPropertyNodes(ConfigurationKey.KeyIterator keyPart,<a name="line.975"></a>
<FONT color="green">976</FONT>                Node node, Collection&lt;ConfigurationNode&gt; nodes)<a name="line.976"></a>
<FONT color="green">977</FONT>        {<a name="line.977"></a>
<FONT color="green">978</FONT>        }<a name="line.978"></a>
<FONT color="green">979</FONT>    <a name="line.979"></a>
<FONT color="green">980</FONT>        /**<a name="line.980"></a>
<FONT color="green">981</FONT>         * Checks if the specified node is defined.<a name="line.981"></a>
<FONT color="green">982</FONT>         *<a name="line.982"></a>
<FONT color="green">983</FONT>         * @param node the node to be checked<a name="line.983"></a>
<FONT color="green">984</FONT>         * @return a flag if this node is defined<a name="line.984"></a>
<FONT color="green">985</FONT>         * @deprecated Use the method {@link #nodeDefined(ConfigurationNode)}<a name="line.985"></a>
<FONT color="green">986</FONT>         * instead.<a name="line.986"></a>
<FONT color="green">987</FONT>         */<a name="line.987"></a>
<FONT color="green">988</FONT>        @Deprecated<a name="line.988"></a>
<FONT color="green">989</FONT>        protected boolean nodeDefined(Node node)<a name="line.989"></a>
<FONT color="green">990</FONT>        {<a name="line.990"></a>
<FONT color="green">991</FONT>            return nodeDefined((ConfigurationNode) node);<a name="line.991"></a>
<FONT color="green">992</FONT>        }<a name="line.992"></a>
<FONT color="green">993</FONT>    <a name="line.993"></a>
<FONT color="green">994</FONT>        /**<a name="line.994"></a>
<FONT color="green">995</FONT>         * Checks if the specified node is defined.<a name="line.995"></a>
<FONT color="green">996</FONT>         *<a name="line.996"></a>
<FONT color="green">997</FONT>         * @param node the node to be checked<a name="line.997"></a>
<FONT color="green">998</FONT>         * @return a flag if this node is defined<a name="line.998"></a>
<FONT color="green">999</FONT>         */<a name="line.999"></a>
<FONT color="green">1000</FONT>        protected boolean nodeDefined(ConfigurationNode node)<a name="line.1000"></a>
<FONT color="green">1001</FONT>        {<a name="line.1001"></a>
<FONT color="green">1002</FONT>            DefinedVisitor visitor = new DefinedVisitor();<a name="line.1002"></a>
<FONT color="green">1003</FONT>            node.visit(visitor);<a name="line.1003"></a>
<FONT color="green">1004</FONT>            return visitor.isDefined();<a name="line.1004"></a>
<FONT color="green">1005</FONT>        }<a name="line.1005"></a>
<FONT color="green">1006</FONT>    <a name="line.1006"></a>
<FONT color="green">1007</FONT>        /**<a name="line.1007"></a>
<FONT color="green">1008</FONT>         * Removes the specified node from this configuration. This method ensures<a name="line.1008"></a>
<FONT color="green">1009</FONT>         * that parent nodes that become undefined by this operation are also<a name="line.1009"></a>
<FONT color="green">1010</FONT>         * removed.<a name="line.1010"></a>
<FONT color="green">1011</FONT>         *<a name="line.1011"></a>
<FONT color="green">1012</FONT>         * @param node the node to be removed<a name="line.1012"></a>
<FONT color="green">1013</FONT>         * @deprecated Use the method {@link #removeNode(ConfigurationNode)}<a name="line.1013"></a>
<FONT color="green">1014</FONT>         * instead.<a name="line.1014"></a>
<FONT color="green">1015</FONT>         */<a name="line.1015"></a>
<FONT color="green">1016</FONT>        @Deprecated<a name="line.1016"></a>
<FONT color="green">1017</FONT>        protected void removeNode(Node node)<a name="line.1017"></a>
<FONT color="green">1018</FONT>        {<a name="line.1018"></a>
<FONT color="green">1019</FONT>            removeNode((ConfigurationNode) node);<a name="line.1019"></a>
<FONT color="green">1020</FONT>        }<a name="line.1020"></a>
<FONT color="green">1021</FONT>    <a name="line.1021"></a>
<FONT color="green">1022</FONT>        /**<a name="line.1022"></a>
<FONT color="green">1023</FONT>         * Removes the specified node from this configuration. This method ensures<a name="line.1023"></a>
<FONT color="green">1024</FONT>         * that parent nodes that become undefined by this operation are also<a name="line.1024"></a>
<FONT color="green">1025</FONT>         * removed.<a name="line.1025"></a>
<FONT color="green">1026</FONT>         *<a name="line.1026"></a>
<FONT color="green">1027</FONT>         * @param node the node to be removed<a name="line.1027"></a>
<FONT color="green">1028</FONT>         */<a name="line.1028"></a>
<FONT color="green">1029</FONT>        protected void removeNode(ConfigurationNode node)<a name="line.1029"></a>
<FONT color="green">1030</FONT>        {<a name="line.1030"></a>
<FONT color="green">1031</FONT>            ConfigurationNode parent = node.getParentNode();<a name="line.1031"></a>
<FONT color="green">1032</FONT>            if (parent != null)<a name="line.1032"></a>
<FONT color="green">1033</FONT>            {<a name="line.1033"></a>
<FONT color="green">1034</FONT>                parent.removeChild(node);<a name="line.1034"></a>
<FONT color="green">1035</FONT>                if (!nodeDefined(parent))<a name="line.1035"></a>
<FONT color="green">1036</FONT>                {<a name="line.1036"></a>
<FONT color="green">1037</FONT>                    removeNode(parent);<a name="line.1037"></a>
<FONT color="green">1038</FONT>                }<a name="line.1038"></a>
<FONT color="green">1039</FONT>            }<a name="line.1039"></a>
<FONT color="green">1040</FONT>        }<a name="line.1040"></a>
<FONT color="green">1041</FONT>    <a name="line.1041"></a>
<FONT color="green">1042</FONT>        /**<a name="line.1042"></a>
<FONT color="green">1043</FONT>         * Clears the value of the specified node. If the node becomes undefined by<a name="line.1043"></a>
<FONT color="green">1044</FONT>         * this operation, it is removed from the hierarchy.<a name="line.1044"></a>
<FONT color="green">1045</FONT>         *<a name="line.1045"></a>
<FONT color="green">1046</FONT>         * @param node the node to be cleared<a name="line.1046"></a>
<FONT color="green">1047</FONT>         * @deprecated Use the method {@link #clearNode(ConfigurationNode)}<a name="line.1047"></a>
<FONT color="green">1048</FONT>         * instead<a name="line.1048"></a>
<FONT color="green">1049</FONT>         */<a name="line.1049"></a>
<FONT color="green">1050</FONT>        @Deprecated<a name="line.1050"></a>
<FONT color="green">1051</FONT>        protected void clearNode(Node node)<a name="line.1051"></a>
<FONT color="green">1052</FONT>        {<a name="line.1052"></a>
<FONT color="green">1053</FONT>            clearNode((ConfigurationNode) node);<a name="line.1053"></a>
<FONT color="green">1054</FONT>        }<a name="line.1054"></a>
<FONT color="green">1055</FONT>    <a name="line.1055"></a>
<FONT color="green">1056</FONT>        /**<a name="line.1056"></a>
<FONT color="green">1057</FONT>         * Clears the value of the specified node. If the node becomes undefined by<a name="line.1057"></a>
<FONT color="green">1058</FONT>         * this operation, it is removed from the hierarchy.<a name="line.1058"></a>
<FONT color="green">1059</FONT>         *<a name="line.1059"></a>
<FONT color="green">1060</FONT>         * @param node the node to be cleared<a name="line.1060"></a>
<FONT color="green">1061</FONT>         */<a name="line.1061"></a>
<FONT color="green">1062</FONT>        protected void clearNode(ConfigurationNode node)<a name="line.1062"></a>
<FONT color="green">1063</FONT>        {<a name="line.1063"></a>
<FONT color="green">1064</FONT>            node.setValue(null);<a name="line.1064"></a>
<FONT color="green">1065</FONT>            if (!nodeDefined(node))<a name="line.1065"></a>
<FONT color="green">1066</FONT>            {<a name="line.1066"></a>
<FONT color="green">1067</FONT>                removeNode(node);<a name="line.1067"></a>
<FONT color="green">1068</FONT>            }<a name="line.1068"></a>
<FONT color="green">1069</FONT>        }<a name="line.1069"></a>
<FONT color="green">1070</FONT>    <a name="line.1070"></a>
<FONT color="green">1071</FONT>        /**<a name="line.1071"></a>
<FONT color="green">1072</FONT>         * Returns a reference to the parent node of an add operation. Nodes for new<a name="line.1072"></a>
<FONT color="green">1073</FONT>         * properties can be added as children of this node. If the path for the<a name="line.1073"></a>
<FONT color="green">1074</FONT>         * specified key does not exist so far, it is created now.<a name="line.1074"></a>
<FONT color="green">1075</FONT>         *<a name="line.1075"></a>
<FONT color="green">1076</FONT>         * @param keyIt the iterator for the key of the new property<a name="line.1076"></a>
<FONT color="green">1077</FONT>         * @param startNode the node to start the search with<a name="line.1077"></a>
<FONT color="green">1078</FONT>         * @return the parent node for the add operation<a name="line.1078"></a>
<FONT color="green">1079</FONT>         * @deprecated Adding new properties is now to a major part delegated to the<a name="line.1079"></a>
<FONT color="green">1080</FONT>         * {@code ExpressionEngine} associated with this configuration instance.<a name="line.1080"></a>
<FONT color="green">1081</FONT>         * This method will no longer be called. Developers who want to modify the<a name="line.1081"></a>
<FONT color="green">1082</FONT>         * process of adding new properties should consider implementing their own<a name="line.1082"></a>
<FONT color="green">1083</FONT>         * expression engine.<a name="line.1083"></a>
<FONT color="green">1084</FONT>         */<a name="line.1084"></a>
<FONT color="green">1085</FONT>        @Deprecated<a name="line.1085"></a>
<FONT color="green">1086</FONT>        protected Node fetchAddNode(ConfigurationKey.KeyIterator keyIt, Node startNode)<a name="line.1086"></a>
<FONT color="green">1087</FONT>        {<a name="line.1087"></a>
<FONT color="green">1088</FONT>            return null;<a name="line.1088"></a>
<FONT color="green">1089</FONT>        }<a name="line.1089"></a>
<FONT color="green">1090</FONT>    <a name="line.1090"></a>
<FONT color="green">1091</FONT>        /**<a name="line.1091"></a>
<FONT color="green">1092</FONT>         * Finds the last existing node for an add operation. This method traverses<a name="line.1092"></a>
<FONT color="green">1093</FONT>         * the configuration tree along the specified key. The last existing node on<a name="line.1093"></a>
<FONT color="green">1094</FONT>         * this path is returned.<a name="line.1094"></a>
<FONT color="green">1095</FONT>         *<a name="line.1095"></a>
<FONT color="green">1096</FONT>         * @param keyIt the key iterator<a name="line.1096"></a>
<FONT color="green">1097</FONT>         * @param node the actual node<a name="line.1097"></a>
<FONT color="green">1098</FONT>         * @return the last existing node on the given path<a name="line.1098"></a>
<FONT color="green">1099</FONT>         * @deprecated Adding new properties is now to a major part delegated to the<a name="line.1099"></a>
<FONT color="green">1100</FONT>         * {@code ExpressionEngine} associated with this configuration instance.<a name="line.1100"></a>
<FONT color="green">1101</FONT>         * This method will no longer be called. Developers who want to modify the<a name="line.1101"></a>
<FONT color="green">1102</FONT>         * process of adding new properties should consider implementing their own<a name="line.1102"></a>
<FONT color="green">1103</FONT>         * expression engine.<a name="line.1103"></a>
<FONT color="green">1104</FONT>         */<a name="line.1104"></a>
<FONT color="green">1105</FONT>        @Deprecated<a name="line.1105"></a>
<FONT color="green">1106</FONT>        protected Node findLastPathNode(ConfigurationKey.KeyIterator keyIt, Node node)<a name="line.1106"></a>
<FONT color="green">1107</FONT>        {<a name="line.1107"></a>
<FONT color="green">1108</FONT>            return null;<a name="line.1108"></a>
<FONT color="green">1109</FONT>        }<a name="line.1109"></a>
<FONT color="green">1110</FONT>    <a name="line.1110"></a>
<FONT color="green">1111</FONT>        /**<a name="line.1111"></a>
<FONT color="green">1112</FONT>         * Creates the missing nodes for adding a new property. This method ensures<a name="line.1112"></a>
<FONT color="green">1113</FONT>         * that there are corresponding nodes for all components of the specified<a name="line.1113"></a>
<FONT color="green">1114</FONT>         * configuration key.<a name="line.1114"></a>
<FONT color="green">1115</FONT>         *<a name="line.1115"></a>
<FONT color="green">1116</FONT>         * @param keyIt the key iterator<a name="line.1116"></a>
<FONT color="green">1117</FONT>         * @param root the base node of the path to be created<a name="line.1117"></a>
<FONT color="green">1118</FONT>         * @return the last node of the path<a name="line.1118"></a>
<FONT color="green">1119</FONT>         * @deprecated Adding new properties is now to a major part delegated to the<a name="line.1119"></a>
<FONT color="green">1120</FONT>         * {@code ExpressionEngine} associated with this configuration instance.<a name="line.1120"></a>
<FONT color="green">1121</FONT>         * This method will no longer be called. Developers who want to modify the<a name="line.1121"></a>
<FONT color="green">1122</FONT>         * process of adding new properties should consider implementing their own<a name="line.1122"></a>
<FONT color="green">1123</FONT>         * expression engine.<a name="line.1123"></a>
<FONT color="green">1124</FONT>         */<a name="line.1124"></a>
<FONT color="green">1125</FONT>        @Deprecated<a name="line.1125"></a>
<FONT color="green">1126</FONT>        protected Node createAddPath(ConfigurationKey.KeyIterator keyIt, Node root)<a name="line.1126"></a>
<FONT color="green">1127</FONT>        {<a name="line.1127"></a>
<FONT color="green">1128</FONT>            return null;<a name="line.1128"></a>
<FONT color="green">1129</FONT>        }<a name="line.1129"></a>
<FONT color="green">1130</FONT>    <a name="line.1130"></a>
<FONT color="green">1131</FONT>        /**<a name="line.1131"></a>
<FONT color="green">1132</FONT>         * Creates a new {@code Node} object with the specified name. This<a name="line.1132"></a>
<FONT color="green">1133</FONT>         * method can be overloaded in derived classes if a specific node type is<a name="line.1133"></a>
<FONT color="green">1134</FONT>         * needed. This base implementation always returns a new object of the<a name="line.1134"></a>
<FONT color="green">1135</FONT>         * {@code Node} class.<a name="line.1135"></a>
<FONT color="green">1136</FONT>         *<a name="line.1136"></a>
<FONT color="green">1137</FONT>         * @param name the name of the new node<a name="line.1137"></a>
<FONT color="green">1138</FONT>         * @return the new node<a name="line.1138"></a>
<FONT color="green">1139</FONT>         */<a name="line.1139"></a>
<FONT color="green">1140</FONT>        protected Node createNode(String name)<a name="line.1140"></a>
<FONT color="green">1141</FONT>        {<a name="line.1141"></a>
<FONT color="green">1142</FONT>            return new Node(name);<a name="line.1142"></a>
<FONT color="green">1143</FONT>        }<a name="line.1143"></a>
<FONT color="green">1144</FONT>    <a name="line.1144"></a>
<FONT color="green">1145</FONT>        /**<a name="line.1145"></a>
<FONT color="green">1146</FONT>         * Helper method for processing a node add data object obtained from the<a name="line.1146"></a>
<FONT color="green">1147</FONT>         * expression engine. This method will create all new nodes.<a name="line.1147"></a>
<FONT color="green">1148</FONT>         *<a name="line.1148"></a>
<FONT color="green">1149</FONT>         * @param data the data object<a name="line.1149"></a>
<FONT color="green">1150</FONT>         * @return the new node<a name="line.1150"></a>
<FONT color="green">1151</FONT>         * @since 1.3<a name="line.1151"></a>
<FONT color="green">1152</FONT>         */<a name="line.1152"></a>
<FONT color="green">1153</FONT>        private ConfigurationNode processNodeAddData(NodeAddData data)<a name="line.1153"></a>
<FONT color="green">1154</FONT>        {<a name="line.1154"></a>
<FONT color="green">1155</FONT>            ConfigurationNode node = data.getParent();<a name="line.1155"></a>
<FONT color="green">1156</FONT>    <a name="line.1156"></a>
<FONT color="green">1157</FONT>            // Create missing nodes on the path<a name="line.1157"></a>
<FONT color="green">1158</FONT>            for (String name : data.getPathNodes())<a name="line.1158"></a>
<FONT color="green">1159</FONT>            {<a name="line.1159"></a>
<FONT color="green">1160</FONT>                ConfigurationNode child = createNode(name);<a name="line.1160"></a>
<FONT color="green">1161</FONT>                node.addChild(child);<a name="line.1161"></a>
<FONT color="green">1162</FONT>                node = child;<a name="line.1162"></a>
<FONT color="green">1163</FONT>            }<a name="line.1163"></a>
<FONT color="green">1164</FONT>    <a name="line.1164"></a>
<FONT color="green">1165</FONT>            // Add new target node<a name="line.1165"></a>
<FONT color="green">1166</FONT>            ConfigurationNode child = createNode(data.getNewNodeName());<a name="line.1166"></a>
<FONT color="green">1167</FONT>            if (data.isAttribute())<a name="line.1167"></a>
<FONT color="green">1168</FONT>            {<a name="line.1168"></a>
<FONT color="green">1169</FONT>                node.addAttribute(child);<a name="line.1169"></a>
<FONT color="green">1170</FONT>            }<a name="line.1170"></a>
<FONT color="green">1171</FONT>            else<a name="line.1171"></a>
<FONT color="green">1172</FONT>            {<a name="line.1172"></a>
<FONT color="green">1173</FONT>                node.addChild(child);<a name="line.1173"></a>
<FONT color="green">1174</FONT>            }<a name="line.1174"></a>
<FONT color="green">1175</FONT>            return child;<a name="line.1175"></a>
<FONT color="green">1176</FONT>        }<a name="line.1176"></a>
<FONT color="green">1177</FONT>    <a name="line.1177"></a>
<FONT color="green">1178</FONT>        /**<a name="line.1178"></a>
<FONT color="green">1179</FONT>         * Clears all reference fields in a node structure. A configuration node can<a name="line.1179"></a>
<FONT color="green">1180</FONT>         * store a so-called &amp;quot;reference&amp;quot;. The meaning of this data is<a name="line.1180"></a>
<FONT color="green">1181</FONT>         * determined by a concrete sub class. Typically such references are<a name="line.1181"></a>
<FONT color="green">1182</FONT>         * specific for a configuration instance. If this instance is cloned or<a name="line.1182"></a>
<FONT color="green">1183</FONT>         * copied, they must be cleared. This can be done using this method.<a name="line.1183"></a>
<FONT color="green">1184</FONT>         *<a name="line.1184"></a>
<FONT color="green">1185</FONT>         * @param node the root node of the node hierarchy, in which the references<a name="line.1185"></a>
<FONT color="green">1186</FONT>         * are to be cleared<a name="line.1186"></a>
<FONT color="green">1187</FONT>         * @since 1.4<a name="line.1187"></a>
<FONT color="green">1188</FONT>         */<a name="line.1188"></a>
<FONT color="green">1189</FONT>        protected static void clearReferences(ConfigurationNode node)<a name="line.1189"></a>
<FONT color="green">1190</FONT>        {<a name="line.1190"></a>
<FONT color="green">1191</FONT>            node.visit(new ConfigurationNodeVisitorAdapter()<a name="line.1191"></a>
<FONT color="green">1192</FONT>            {<a name="line.1192"></a>
<FONT color="green">1193</FONT>                @Override<a name="line.1193"></a>
<FONT color="green">1194</FONT>                public void visitBeforeChildren(ConfigurationNode node)<a name="line.1194"></a>
<FONT color="green">1195</FONT>                {<a name="line.1195"></a>
<FONT color="green">1196</FONT>                    node.setReference(null);<a name="line.1196"></a>
<FONT color="green">1197</FONT>                }<a name="line.1197"></a>
<FONT color="green">1198</FONT>            });<a name="line.1198"></a>
<FONT color="green">1199</FONT>        }<a name="line.1199"></a>
<FONT color="green">1200</FONT>    <a name="line.1200"></a>
<FONT color="green">1201</FONT>        /**<a name="line.1201"></a>
<FONT color="green">1202</FONT>         * Transforms the specified object into a Node. This method treats view<a name="line.1202"></a>
<FONT color="green">1203</FONT>         * nodes in a special way. This is necessary because ViewNode does not<a name="line.1203"></a>
<FONT color="green">1204</FONT>         * extend HierarchicalConfiguration.Node; thus the API for the node visitor<a name="line.1204"></a>
<FONT color="green">1205</FONT>         * is slightly different. Therefore a view node is transformed into a<a name="line.1205"></a>
<FONT color="green">1206</FONT>         * special compatibility Node object.<a name="line.1206"></a>
<FONT color="green">1207</FONT>         *<a name="line.1207"></a>
<FONT color="green">1208</FONT>         * @param obj the original node object<a name="line.1208"></a>
<FONT color="green">1209</FONT>         * @return the node to be used<a name="line.1209"></a>
<FONT color="green">1210</FONT>         */<a name="line.1210"></a>
<FONT color="green">1211</FONT>        private static Node getNodeFor(Object obj)<a name="line.1211"></a>
<FONT color="green">1212</FONT>        {<a name="line.1212"></a>
<FONT color="green">1213</FONT>            Node nd;<a name="line.1213"></a>
<FONT color="green">1214</FONT>            if (obj instanceof ViewNode)<a name="line.1214"></a>
<FONT color="green">1215</FONT>            {<a name="line.1215"></a>
<FONT color="green">1216</FONT>                final ViewNode viewNode = (ViewNode) obj;<a name="line.1216"></a>
<FONT color="green">1217</FONT>                nd = new Node(viewNode)<a name="line.1217"></a>
<FONT color="green">1218</FONT>                {<a name="line.1218"></a>
<FONT color="green">1219</FONT>                    @Override<a name="line.1219"></a>
<FONT color="green">1220</FONT>                    public void setReference(Object reference)<a name="line.1220"></a>
<FONT color="green">1221</FONT>                    {<a name="line.1221"></a>
<FONT color="green">1222</FONT>                        super.setReference(reference);<a name="line.1222"></a>
<FONT color="green">1223</FONT>                        // also set the reference at the original node<a name="line.1223"></a>
<FONT color="green">1224</FONT>                        viewNode.setReference(reference);<a name="line.1224"></a>
<FONT color="green">1225</FONT>                    }<a name="line.1225"></a>
<FONT color="green">1226</FONT>                };<a name="line.1226"></a>
<FONT color="green">1227</FONT>            }<a name="line.1227"></a>
<FONT color="green">1228</FONT>            else<a name="line.1228"></a>
<FONT color="green">1229</FONT>            {<a name="line.1229"></a>
<FONT color="green">1230</FONT>                nd = (Node) obj;<a name="line.1230"></a>
<FONT color="green">1231</FONT>            }<a name="line.1231"></a>
<FONT color="green">1232</FONT>            return nd;<a name="line.1232"></a>
<FONT color="green">1233</FONT>        }<a name="line.1233"></a>
<FONT color="green">1234</FONT>    <a name="line.1234"></a>
<FONT color="green">1235</FONT>        /**<a name="line.1235"></a>
<FONT color="green">1236</FONT>         * A data class for storing (hierarchical) property information. A property<a name="line.1236"></a>
<FONT color="green">1237</FONT>         * can have a value and an arbitrary number of child properties. From<a name="line.1237"></a>
<FONT color="green">1238</FONT>         * version 1.3 on this class is only a thin wrapper over the<a name="line.1238"></a>
<FONT color="green">1239</FONT>         * {@link org.apache.commons.configuration.tree.DefaultConfigurationNode DefaultconfigurationNode}<a name="line.1239"></a>
<FONT color="green">1240</FONT>         * class that exists mainly for the purpose of backwards compatibility.<a name="line.1240"></a>
<FONT color="green">1241</FONT>         */<a name="line.1241"></a>
<FONT color="green">1242</FONT>        public static class Node extends DefaultConfigurationNode implements Serializable<a name="line.1242"></a>
<FONT color="green">1243</FONT>        {<a name="line.1243"></a>
<FONT color="green">1244</FONT>            /**<a name="line.1244"></a>
<FONT color="green">1245</FONT>             * The serial version UID.<a name="line.1245"></a>
<FONT color="green">1246</FONT>             */<a name="line.1246"></a>
<FONT color="green">1247</FONT>            private static final long serialVersionUID = -6357500633536941775L;<a name="line.1247"></a>
<FONT color="green">1248</FONT>    <a name="line.1248"></a>
<FONT color="green">1249</FONT>            /**<a name="line.1249"></a>
<FONT color="green">1250</FONT>             * Creates a new instance of {@code Node}.<a name="line.1250"></a>
<FONT color="green">1251</FONT>             */<a name="line.1251"></a>
<FONT color="green">1252</FONT>            public Node()<a name="line.1252"></a>
<FONT color="green">1253</FONT>            {<a name="line.1253"></a>
<FONT color="green">1254</FONT>                super();<a name="line.1254"></a>
<FONT color="green">1255</FONT>            }<a name="line.1255"></a>
<FONT color="green">1256</FONT>    <a name="line.1256"></a>
<FONT color="green">1257</FONT>            /**<a name="line.1257"></a>
<FONT color="green">1258</FONT>             * Creates a new instance of {@code Node} and sets the name.<a name="line.1258"></a>
<FONT color="green">1259</FONT>             *<a name="line.1259"></a>
<FONT color="green">1260</FONT>             * @param name the node's name<a name="line.1260"></a>
<FONT color="green">1261</FONT>             */<a name="line.1261"></a>
<FONT color="green">1262</FONT>            public Node(String name)<a name="line.1262"></a>
<FONT color="green">1263</FONT>            {<a name="line.1263"></a>
<FONT color="green">1264</FONT>                super(name);<a name="line.1264"></a>
<FONT color="green">1265</FONT>            }<a name="line.1265"></a>
<FONT color="green">1266</FONT>    <a name="line.1266"></a>
<FONT color="green">1267</FONT>            /**<a name="line.1267"></a>
<FONT color="green">1268</FONT>             * Creates a new instance of {@code Node} and sets the name and the value.<a name="line.1268"></a>
<FONT color="green">1269</FONT>             *<a name="line.1269"></a>
<FONT color="green">1270</FONT>             * @param name the node's name<a name="line.1270"></a>
<FONT color="green">1271</FONT>             * @param value the value<a name="line.1271"></a>
<FONT color="green">1272</FONT>             */<a name="line.1272"></a>
<FONT color="green">1273</FONT>            public Node(String name, Object value)<a name="line.1273"></a>
<FONT color="green">1274</FONT>            {<a name="line.1274"></a>
<FONT color="green">1275</FONT>                super(name, value);<a name="line.1275"></a>
<FONT color="green">1276</FONT>            }<a name="line.1276"></a>
<FONT color="green">1277</FONT>    <a name="line.1277"></a>
<FONT color="green">1278</FONT>            /**<a name="line.1278"></a>
<FONT color="green">1279</FONT>             * Creates a new instance of {@code Node} based on the given<a name="line.1279"></a>
<FONT color="green">1280</FONT>             * source node. All properties of the source node, including its<a name="line.1280"></a>
<FONT color="green">1281</FONT>             * children and attributes, will be copied.<a name="line.1281"></a>
<FONT color="green">1282</FONT>             *<a name="line.1282"></a>
<FONT color="green">1283</FONT>             * @param src the node to be copied<a name="line.1283"></a>
<FONT color="green">1284</FONT>             */<a name="line.1284"></a>
<FONT color="green">1285</FONT>            public Node(ConfigurationNode src)<a name="line.1285"></a>
<FONT color="green">1286</FONT>            {<a name="line.1286"></a>
<FONT color="green">1287</FONT>                this(src.getName(), src.getValue());<a name="line.1287"></a>
<FONT color="green">1288</FONT>                setReference(src.getReference());<a name="line.1288"></a>
<FONT color="green">1289</FONT>                for (ConfigurationNode nd : src.getChildren())<a name="line.1289"></a>
<FONT color="green">1290</FONT>                {<a name="line.1290"></a>
<FONT color="green">1291</FONT>                    // Don't change the parent node<a name="line.1291"></a>
<FONT color="green">1292</FONT>                    ConfigurationNode parent = nd.getParentNode();<a name="line.1292"></a>
<FONT color="green">1293</FONT>                    addChild(nd);<a name="line.1293"></a>
<FONT color="green">1294</FONT>                    nd.setParentNode(parent);<a name="line.1294"></a>
<FONT color="green">1295</FONT>                }<a name="line.1295"></a>
<FONT color="green">1296</FONT>    <a name="line.1296"></a>
<FONT color="green">1297</FONT>                for (ConfigurationNode nd : src.getAttributes())<a name="line.1297"></a>
<FONT color="green">1298</FONT>                {<a name="line.1298"></a>
<FONT color="green">1299</FONT>                    // Don't change the parent node<a name="line.1299"></a>
<FONT color="green">1300</FONT>                    ConfigurationNode parent = nd.getParentNode();<a name="line.1300"></a>
<FONT color="green">1301</FONT>                    addAttribute(nd);<a name="line.1301"></a>
<FONT color="green">1302</FONT>                    nd.setParentNode(parent);<a name="line.1302"></a>
<FONT color="green">1303</FONT>                }<a name="line.1303"></a>
<FONT color="green">1304</FONT>            }<a name="line.1304"></a>
<FONT color="green">1305</FONT>    <a name="line.1305"></a>
<FONT color="green">1306</FONT>            /**<a name="line.1306"></a>
<FONT color="green">1307</FONT>             * Returns the parent of this node.<a name="line.1307"></a>
<FONT color="green">1308</FONT>             *<a name="line.1308"></a>
<FONT color="green">1309</FONT>             * @return this node's parent (can be &lt;b&gt;null&lt;/b&gt;)<a name="line.1309"></a>
<FONT color="green">1310</FONT>             */<a name="line.1310"></a>
<FONT color="green">1311</FONT>            public Node getParent()<a name="line.1311"></a>
<FONT color="green">1312</FONT>            {<a name="line.1312"></a>
<FONT color="green">1313</FONT>                return (Node) getParentNode();<a name="line.1313"></a>
<FONT color="green">1314</FONT>            }<a name="line.1314"></a>
<FONT color="green">1315</FONT>    <a name="line.1315"></a>
<FONT color="green">1316</FONT>            /**<a name="line.1316"></a>
<FONT color="green">1317</FONT>             * Sets the parent of this node.<a name="line.1317"></a>
<FONT color="green">1318</FONT>             *<a name="line.1318"></a>
<FONT color="green">1319</FONT>             * @param node the parent node<a name="line.1319"></a>
<FONT color="green">1320</FONT>             */<a name="line.1320"></a>
<FONT color="green">1321</FONT>            public void setParent(Node node)<a name="line.1321"></a>
<FONT color="green">1322</FONT>            {<a name="line.1322"></a>
<FONT color="green">1323</FONT>                setParentNode(node);<a name="line.1323"></a>
<FONT color="green">1324</FONT>            }<a name="line.1324"></a>
<FONT color="green">1325</FONT>    <a name="line.1325"></a>
<FONT color="green">1326</FONT>            /**<a name="line.1326"></a>
<FONT color="green">1327</FONT>             * Adds the given node to the children of this node.<a name="line.1327"></a>
<FONT color="green">1328</FONT>             *<a name="line.1328"></a>
<FONT color="green">1329</FONT>             * @param node the child to be added<a name="line.1329"></a>
<FONT color="green">1330</FONT>             */<a name="line.1330"></a>
<FONT color="green">1331</FONT>            public void addChild(Node node)<a name="line.1331"></a>
<FONT color="green">1332</FONT>            {<a name="line.1332"></a>
<FONT color="green">1333</FONT>                addChild((ConfigurationNode) node);<a name="line.1333"></a>
<FONT color="green">1334</FONT>            }<a name="line.1334"></a>
<FONT color="green">1335</FONT>    <a name="line.1335"></a>
<FONT color="green">1336</FONT>            /**<a name="line.1336"></a>
<FONT color="green">1337</FONT>             * Returns a flag whether this node has child elements.<a name="line.1337"></a>
<FONT color="green">1338</FONT>             *<a name="line.1338"></a>
<FONT color="green">1339</FONT>             * @return &lt;b&gt;true&lt;/b&gt; if there is a child node, &lt;b&gt;false&lt;/b&gt; otherwise<a name="line.1339"></a>
<FONT color="green">1340</FONT>             */<a name="line.1340"></a>
<FONT color="green">1341</FONT>            public boolean hasChildren()<a name="line.1341"></a>
<FONT color="green">1342</FONT>            {<a name="line.1342"></a>
<FONT color="green">1343</FONT>                return getChildrenCount() &gt; 0 || getAttributeCount() &gt; 0;<a name="line.1343"></a>
<FONT color="green">1344</FONT>            }<a name="line.1344"></a>
<FONT color="green">1345</FONT>    <a name="line.1345"></a>
<FONT color="green">1346</FONT>            /**<a name="line.1346"></a>
<FONT color="green">1347</FONT>             * Removes the specified child from this node.<a name="line.1347"></a>
<FONT color="green">1348</FONT>             *<a name="line.1348"></a>
<FONT color="green">1349</FONT>             * @param child the child node to be removed<a name="line.1349"></a>
<FONT color="green">1350</FONT>             * @return a flag if the child could be found<a name="line.1350"></a>
<FONT color="green">1351</FONT>             */<a name="line.1351"></a>
<FONT color="green">1352</FONT>            public boolean remove(Node child)<a name="line.1352"></a>
<FONT color="green">1353</FONT>            {<a name="line.1353"></a>
<FONT color="green">1354</FONT>                return child.isAttribute() ? removeAttribute(child) : removeChild(child);<a name="line.1354"></a>
<FONT color="green">1355</FONT>            }<a name="line.1355"></a>
<FONT color="green">1356</FONT>    <a name="line.1356"></a>
<FONT color="green">1357</FONT>            /**<a name="line.1357"></a>
<FONT color="green">1358</FONT>             * Removes all children with the given name.<a name="line.1358"></a>
<FONT color="green">1359</FONT>             *<a name="line.1359"></a>
<FONT color="green">1360</FONT>             * @param name the name of the children to be removed<a name="line.1360"></a>
<FONT color="green">1361</FONT>             * @return a flag if children with this name existed<a name="line.1361"></a>
<FONT color="green">1362</FONT>             */<a name="line.1362"></a>
<FONT color="green">1363</FONT>            public boolean remove(String name)<a name="line.1363"></a>
<FONT color="green">1364</FONT>            {<a name="line.1364"></a>
<FONT color="green">1365</FONT>                boolean childrenRemoved = removeChild(name);<a name="line.1365"></a>
<FONT color="green">1366</FONT>                boolean attrsRemoved = removeAttribute(name);<a name="line.1366"></a>
<FONT color="green">1367</FONT>                return childrenRemoved || attrsRemoved;<a name="line.1367"></a>
<FONT color="green">1368</FONT>            }<a name="line.1368"></a>
<FONT color="green">1369</FONT>    <a name="line.1369"></a>
<FONT color="green">1370</FONT>            /**<a name="line.1370"></a>
<FONT color="green">1371</FONT>             * A generic method for traversing this node and all of its children.<a name="line.1371"></a>
<FONT color="green">1372</FONT>             * This method sends the passed in visitor to this node and all of its<a name="line.1372"></a>
<FONT color="green">1373</FONT>             * children.<a name="line.1373"></a>
<FONT color="green">1374</FONT>             *<a name="line.1374"></a>
<FONT color="green">1375</FONT>             * @param visitor the visitor<a name="line.1375"></a>
<FONT color="green">1376</FONT>             * @param key here a configuration key with the name of the root node of<a name="line.1376"></a>
<FONT color="green">1377</FONT>             * the iteration can be passed; if this key is not &lt;b&gt;null &lt;/b&gt;, the<a name="line.1377"></a>
<FONT color="green">1378</FONT>             * full paths to the visited nodes are builded and passed to the<a name="line.1378"></a>
<FONT color="green">1379</FONT>             * visitor's {@code visit()} methods<a name="line.1379"></a>
<FONT color="green">1380</FONT>             */<a name="line.1380"></a>
<FONT color="green">1381</FONT>            public void visit(NodeVisitor visitor, ConfigurationKey key)<a name="line.1381"></a>
<FONT color="green">1382</FONT>            {<a name="line.1382"></a>
<FONT color="green">1383</FONT>                int length = 0;<a name="line.1383"></a>
<FONT color="green">1384</FONT>                if (key != null)<a name="line.1384"></a>
<FONT color="green">1385</FONT>                {<a name="line.1385"></a>
<FONT color="green">1386</FONT>                    length = key.length();<a name="line.1386"></a>
<FONT color="green">1387</FONT>                    if (getName() != null)<a name="line.1387"></a>
<FONT color="green">1388</FONT>                    {<a name="line.1388"></a>
<FONT color="green">1389</FONT>                        key<a name="line.1389"></a>
<FONT color="green">1390</FONT>                                .append(StringUtils<a name="line.1390"></a>
<FONT color="green">1391</FONT>                                        .replace(<a name="line.1391"></a>
<FONT color="green">1392</FONT>                                                isAttribute() ? ConfigurationKey<a name="line.1392"></a>
<FONT color="green">1393</FONT>                                                        .constructAttributeKey(getName())<a name="line.1393"></a>
<FONT color="green">1394</FONT>                                                        : getName(),<a name="line.1394"></a>
<FONT color="green">1395</FONT>                                                String<a name="line.1395"></a>
<FONT color="green">1396</FONT>                                                        .valueOf(ConfigurationKey.PROPERTY_DELIMITER),<a name="line.1396"></a>
<FONT color="green">1397</FONT>                                                ConfigurationKey.ESCAPED_DELIMITER));<a name="line.1397"></a>
<FONT color="green">1398</FONT>                    }<a name="line.1398"></a>
<FONT color="green">1399</FONT>                }<a name="line.1399"></a>
<FONT color="green">1400</FONT>    <a name="line.1400"></a>
<FONT color="green">1401</FONT>                visitor.visitBeforeChildren(this, key);<a name="line.1401"></a>
<FONT color="green">1402</FONT>    <a name="line.1402"></a>
<FONT color="green">1403</FONT>                for (Iterator&lt;ConfigurationNode&gt; it = getChildren().iterator(); it.hasNext()<a name="line.1403"></a>
<FONT color="green">1404</FONT>                        &amp;&amp; !visitor.terminate();)<a name="line.1404"></a>
<FONT color="green">1405</FONT>                {<a name="line.1405"></a>
<FONT color="green">1406</FONT>                    Object obj = it.next();<a name="line.1406"></a>
<FONT color="green">1407</FONT>                    getNodeFor(obj).visit(visitor, key);<a name="line.1407"></a>
<FONT color="green">1408</FONT>                }<a name="line.1408"></a>
<FONT color="green">1409</FONT>                for (Iterator&lt;ConfigurationNode&gt; it = getAttributes().iterator(); it.hasNext()<a name="line.1409"></a>
<FONT color="green">1410</FONT>                        &amp;&amp; !visitor.terminate();)<a name="line.1410"></a>
<FONT color="green">1411</FONT>                {<a name="line.1411"></a>
<FONT color="green">1412</FONT>                    Object obj = it.next();<a name="line.1412"></a>
<FONT color="green">1413</FONT>                    getNodeFor(obj).visit(visitor, key);<a name="line.1413"></a>
<FONT color="green">1414</FONT>                }<a name="line.1414"></a>
<FONT color="green">1415</FONT>    <a name="line.1415"></a>
<FONT color="green">1416</FONT>                visitor.visitAfterChildren(this, key);<a name="line.1416"></a>
<FONT color="green">1417</FONT>                if (key != null)<a name="line.1417"></a>
<FONT color="green">1418</FONT>                {<a name="line.1418"></a>
<FONT color="green">1419</FONT>                    key.setLength(length);<a name="line.1419"></a>
<FONT color="green">1420</FONT>                }<a name="line.1420"></a>
<FONT color="green">1421</FONT>            }<a name="line.1421"></a>
<FONT color="green">1422</FONT>        }<a name="line.1422"></a>
<FONT color="green">1423</FONT>    <a name="line.1423"></a>
<FONT color="green">1424</FONT>        /**<a name="line.1424"></a>
<FONT color="green">1425</FONT>         * &lt;p&gt;Definition of a visitor class for traversing a node and all of its<a name="line.1425"></a>
<FONT color="green">1426</FONT>         * children.&lt;/p&gt;&lt;p&gt;This class defines the interface of a visitor for<a name="line.1426"></a>
<FONT color="green">1427</FONT>         * {@code Node} objects and provides a default implementation. The<a name="line.1427"></a>
<FONT color="green">1428</FONT>         * method {@code visit()} of {@code Node} implements a generic<a name="line.1428"></a>
<FONT color="green">1429</FONT>         * iteration algorithm based on the &lt;em&gt;Visitor&lt;/em&gt; pattern. By providing<a name="line.1429"></a>
<FONT color="green">1430</FONT>         * different implementations of visitors it is possible to collect different<a name="line.1430"></a>
<FONT color="green">1431</FONT>         * data during the iteration process.&lt;/p&gt;<a name="line.1431"></a>
<FONT color="green">1432</FONT>         *<a name="line.1432"></a>
<FONT color="green">1433</FONT>         */<a name="line.1433"></a>
<FONT color="green">1434</FONT>        public static class NodeVisitor<a name="line.1434"></a>
<FONT color="green">1435</FONT>        {<a name="line.1435"></a>
<FONT color="green">1436</FONT>            /**<a name="line.1436"></a>
<FONT color="green">1437</FONT>             * Visits the specified node. This method is called during iteration for<a name="line.1437"></a>
<FONT color="green">1438</FONT>             * each node before its children have been visited.<a name="line.1438"></a>
<FONT color="green">1439</FONT>             *<a name="line.1439"></a>
<FONT color="green">1440</FONT>             * @param node the actual node<a name="line.1440"></a>
<FONT color="green">1441</FONT>             * @param key the key of this node (may be &lt;b&gt;null &lt;/b&gt;)<a name="line.1441"></a>
<FONT color="green">1442</FONT>             */<a name="line.1442"></a>
<FONT color="green">1443</FONT>            public void visitBeforeChildren(Node node, ConfigurationKey key)<a name="line.1443"></a>
<FONT color="green">1444</FONT>            {<a name="line.1444"></a>
<FONT color="green">1445</FONT>            }<a name="line.1445"></a>
<FONT color="green">1446</FONT>    <a name="line.1446"></a>
<FONT color="green">1447</FONT>            /**<a name="line.1447"></a>
<FONT color="green">1448</FONT>             * Visits the specified node after its children have been processed.<a name="line.1448"></a>
<FONT color="green">1449</FONT>             * This gives a visitor the opportunity of collecting additional data<a name="line.1449"></a>
<FONT color="green">1450</FONT>             * after the child nodes have been visited.<a name="line.1450"></a>
<FONT color="green">1451</FONT>             *<a name="line.1451"></a>
<FONT color="green">1452</FONT>             * @param node the node to be visited<a name="line.1452"></a>
<FONT color="green">1453</FONT>             * @param key the key of this node (may be &lt;b&gt;null &lt;/b&gt;)<a name="line.1453"></a>
<FONT color="green">1454</FONT>             */<a name="line.1454"></a>
<FONT color="green">1455</FONT>            public void visitAfterChildren(Node node, ConfigurationKey key)<a name="line.1455"></a>
<FONT color="green">1456</FONT>            {<a name="line.1456"></a>
<FONT color="green">1457</FONT>            }<a name="line.1457"></a>
<FONT color="green">1458</FONT>    <a name="line.1458"></a>
<FONT color="green">1459</FONT>            /**<a name="line.1459"></a>
<FONT color="green">1460</FONT>             * Returns a flag that indicates if iteration should be stopped. This<a name="line.1460"></a>
<FONT color="green">1461</FONT>             * method is called after each visited node. It can be useful for<a name="line.1461"></a>
<FONT color="green">1462</FONT>             * visitors that search a specific node. If this node is found, the<a name="line.1462"></a>
<FONT color="green">1463</FONT>             * whole process can be stopped. This base implementation always returns<a name="line.1463"></a>
<FONT color="green">1464</FONT>             * &lt;b&gt;false &lt;/b&gt;.<a name="line.1464"></a>
<FONT color="green">1465</FONT>             *<a name="line.1465"></a>
<FONT color="green">1466</FONT>             * @return a flag if iteration should be stopped<a name="line.1466"></a>
<FONT color="green">1467</FONT>             */<a name="line.1467"></a>
<FONT color="green">1468</FONT>            public boolean terminate()<a name="line.1468"></a>
<FONT color="green">1469</FONT>            {<a name="line.1469"></a>
<FONT color="green">1470</FONT>                return false;<a name="line.1470"></a>
<FONT color="green">1471</FONT>            }<a name="line.1471"></a>
<FONT color="green">1472</FONT>        }<a name="line.1472"></a>
<FONT color="green">1473</FONT>    <a name="line.1473"></a>
<FONT color="green">1474</FONT>        /**<a name="line.1474"></a>
<FONT color="green">1475</FONT>         * A specialized visitor that checks if a node is defined.<a name="line.1475"></a>
<FONT color="green">1476</FONT>         * &amp;quot;Defined&amp;quot; in this terms means that the node or at least one of<a name="line.1476"></a>
<FONT color="green">1477</FONT>         * its sub nodes is associated with a value.<a name="line.1477"></a>
<FONT color="green">1478</FONT>         *<a name="line.1478"></a>
<FONT color="green">1479</FONT>         */<a name="line.1479"></a>
<FONT color="green">1480</FONT>        static class DefinedVisitor extends ConfigurationNodeVisitorAdapter<a name="line.1480"></a>
<FONT color="green">1481</FONT>        {<a name="line.1481"></a>
<FONT color="green">1482</FONT>            /** Stores the defined flag. */<a name="line.1482"></a>
<FONT color="green">1483</FONT>            private boolean defined;<a name="line.1483"></a>
<FONT color="green">1484</FONT>    <a name="line.1484"></a>
<FONT color="green">1485</FONT>            /**<a name="line.1485"></a>
<FONT color="green">1486</FONT>             * Checks if iteration should be stopped. This can be done if the first<a name="line.1486"></a>
<FONT color="green">1487</FONT>             * defined node is found.<a name="line.1487"></a>
<FONT color="green">1488</FONT>             *<a name="line.1488"></a>
<FONT color="green">1489</FONT>             * @return a flag if iteration should be stopped<a name="line.1489"></a>
<FONT color="green">1490</FONT>             */<a name="line.1490"></a>
<FONT color="green">1491</FONT>            @Override<a name="line.1491"></a>
<FONT color="green">1492</FONT>            public boolean terminate()<a name="line.1492"></a>
<FONT color="green">1493</FONT>            {<a name="line.1493"></a>
<FONT color="green">1494</FONT>                return isDefined();<a name="line.1494"></a>
<FONT color="green">1495</FONT>            }<a name="line.1495"></a>
<FONT color="green">1496</FONT>    <a name="line.1496"></a>
<FONT color="green">1497</FONT>            /**<a name="line.1497"></a>
<FONT color="green">1498</FONT>             * Visits the node. Checks if a value is defined.<a name="line.1498"></a>
<FONT color="green">1499</FONT>             *<a name="line.1499"></a>
<FONT color="green">1500</FONT>             * @param node the actual node<a name="line.1500"></a>
<FONT color="green">1501</FONT>             */<a name="line.1501"></a>
<FONT color="green">1502</FONT>            @Override<a name="line.1502"></a>
<FONT color="green">1503</FONT>            public void visitBeforeChildren(ConfigurationNode node)<a name="line.1503"></a>
<FONT color="green">1504</FONT>            {<a name="line.1504"></a>
<FONT color="green">1505</FONT>                defined = node.getValue() != null;<a name="line.1505"></a>
<FONT color="green">1506</FONT>            }<a name="line.1506"></a>
<FONT color="green">1507</FONT>    <a name="line.1507"></a>
<FONT color="green">1508</FONT>            /**<a name="line.1508"></a>
<FONT color="green">1509</FONT>             * Returns the defined flag.<a name="line.1509"></a>
<FONT color="green">1510</FONT>             *<a name="line.1510"></a>
<FONT color="green">1511</FONT>             * @return the defined flag<a name="line.1511"></a>
<FONT color="green">1512</FONT>             */<a name="line.1512"></a>
<FONT color="green">1513</FONT>            public boolean isDefined()<a name="line.1513"></a>
<FONT color="green">1514</FONT>            {<a name="line.1514"></a>
<FONT color="green">1515</FONT>                return defined;<a name="line.1515"></a>
<FONT color="green">1516</FONT>            }<a name="line.1516"></a>
<FONT color="green">1517</FONT>        }<a name="line.1517"></a>
<FONT color="green">1518</FONT>    <a name="line.1518"></a>
<FONT color="green">1519</FONT>        /**<a name="line.1519"></a>
<FONT color="green">1520</FONT>         * A specialized visitor that fills a list with keys that are defined in a<a name="line.1520"></a>
<FONT color="green">1521</FONT>         * node hierarchy.<a name="line.1521"></a>
<FONT color="green">1522</FONT>         */<a name="line.1522"></a>
<FONT color="green">1523</FONT>        class DefinedKeysVisitor extends ConfigurationNodeVisitorAdapter<a name="line.1523"></a>
<FONT color="green">1524</FONT>        {<a name="line.1524"></a>
<FONT color="green">1525</FONT>            /** Stores the list to be filled. */<a name="line.1525"></a>
<FONT color="green">1526</FONT>            private Set&lt;String&gt; keyList;<a name="line.1526"></a>
<FONT color="green">1527</FONT>    <a name="line.1527"></a>
<FONT color="green">1528</FONT>            /** A stack with the keys of the already processed nodes. */<a name="line.1528"></a>
<FONT color="green">1529</FONT>            private Stack&lt;String&gt; parentKeys;<a name="line.1529"></a>
<FONT color="green">1530</FONT>    <a name="line.1530"></a>
<FONT color="green">1531</FONT>            /**<a name="line.1531"></a>
<FONT color="green">1532</FONT>             * Default constructor.<a name="line.1532"></a>
<FONT color="green">1533</FONT>             */<a name="line.1533"></a>
<FONT color="green">1534</FONT>            public DefinedKeysVisitor()<a name="line.1534"></a>
<FONT color="green">1535</FONT>            {<a name="line.1535"></a>
<FONT color="green">1536</FONT>                keyList = new LinkedHashSet&lt;String&gt;();<a name="line.1536"></a>
<FONT color="green">1537</FONT>                parentKeys = new Stack&lt;String&gt;();<a name="line.1537"></a>
<FONT color="green">1538</FONT>            }<a name="line.1538"></a>
<FONT color="green">1539</FONT>    <a name="line.1539"></a>
<FONT color="green">1540</FONT>            /**<a name="line.1540"></a>
<FONT color="green">1541</FONT>             * Creates a new {@code DefinedKeysVisitor} instance and sets the<a name="line.1541"></a>
<FONT color="green">1542</FONT>             * prefix for the keys to fetch.<a name="line.1542"></a>
<FONT color="green">1543</FONT>             *<a name="line.1543"></a>
<FONT color="green">1544</FONT>             * @param prefix the prefix<a name="line.1544"></a>
<FONT color="green">1545</FONT>             */<a name="line.1545"></a>
<FONT color="green">1546</FONT>            public DefinedKeysVisitor(String prefix)<a name="line.1546"></a>
<FONT color="green">1547</FONT>            {<a name="line.1547"></a>
<FONT color="green">1548</FONT>                this();<a name="line.1548"></a>
<FONT color="green">1549</FONT>                parentKeys.push(prefix);<a name="line.1549"></a>
<FONT color="green">1550</FONT>            }<a name="line.1550"></a>
<FONT color="green">1551</FONT>    <a name="line.1551"></a>
<FONT color="green">1552</FONT>            /**<a name="line.1552"></a>
<FONT color="green">1553</FONT>             * Returns the list with all defined keys.<a name="line.1553"></a>
<FONT color="green">1554</FONT>             *<a name="line.1554"></a>
<FONT color="green">1555</FONT>             * @return the list with the defined keys<a name="line.1555"></a>
<FONT color="green">1556</FONT>             */<a name="line.1556"></a>
<FONT color="green">1557</FONT>            public Set&lt;String&gt; getKeyList()<a name="line.1557"></a>
<FONT color="green">1558</FONT>            {<a name="line.1558"></a>
<FONT color="green">1559</FONT>                return keyList;<a name="line.1559"></a>
<FONT color="green">1560</FONT>            }<a name="line.1560"></a>
<FONT color="green">1561</FONT>    <a name="line.1561"></a>
<FONT color="green">1562</FONT>            /**<a name="line.1562"></a>
<FONT color="green">1563</FONT>             * Visits the node after its children has been processed. Removes this<a name="line.1563"></a>
<FONT color="green">1564</FONT>             * node's key from the stack.<a name="line.1564"></a>
<FONT color="green">1565</FONT>             *<a name="line.1565"></a>
<FONT color="green">1566</FONT>             * @param node the node<a name="line.1566"></a>
<FONT color="green">1567</FONT>             */<a name="line.1567"></a>
<FONT color="green">1568</FONT>            @Override<a name="line.1568"></a>
<FONT color="green">1569</FONT>            public void visitAfterChildren(ConfigurationNode node)<a name="line.1569"></a>
<FONT color="green">1570</FONT>            {<a name="line.1570"></a>
<FONT color="green">1571</FONT>                parentKeys.pop();<a name="line.1571"></a>
<FONT color="green">1572</FONT>            }<a name="line.1572"></a>
<FONT color="green">1573</FONT>    <a name="line.1573"></a>
<FONT color="green">1574</FONT>            /**<a name="line.1574"></a>
<FONT color="green">1575</FONT>             * Visits the specified node. If this node has a value, its key is added<a name="line.1575"></a>
<FONT color="green">1576</FONT>             * to the internal list.<a name="line.1576"></a>
<FONT color="green">1577</FONT>             *<a name="line.1577"></a>
<FONT color="green">1578</FONT>             * @param node the node to be visited<a name="line.1578"></a>
<FONT color="green">1579</FONT>             */<a name="line.1579"></a>
<FONT color="green">1580</FONT>            @Override<a name="line.1580"></a>
<FONT color="green">1581</FONT>            public void visitBeforeChildren(ConfigurationNode node)<a name="line.1581"></a>
<FONT color="green">1582</FONT>            {<a name="line.1582"></a>
<FONT color="green">1583</FONT>                String parentKey = parentKeys.isEmpty() ? null<a name="line.1583"></a>
<FONT color="green">1584</FONT>                        : (String) parentKeys.peek();<a name="line.1584"></a>
<FONT color="green">1585</FONT>                String key = getExpressionEngine().nodeKey(node, parentKey);<a name="line.1585"></a>
<FONT color="green">1586</FONT>                parentKeys.push(key);<a name="line.1586"></a>
<FONT color="green">1587</FONT>                if (node.getValue() != null)<a name="line.1587"></a>
<FONT color="green">1588</FONT>                {<a name="line.1588"></a>
<FONT color="green">1589</FONT>                    keyList.add(key);<a name="line.1589"></a>
<FONT color="green">1590</FONT>                }<a name="line.1590"></a>
<FONT color="green">1591</FONT>            }<a name="line.1591"></a>
<FONT color="green">1592</FONT>        }<a name="line.1592"></a>
<FONT color="green">1593</FONT>    <a name="line.1593"></a>
<FONT color="green">1594</FONT>        /**<a name="line.1594"></a>
<FONT color="green">1595</FONT>         * A specialized visitor that is able to create a deep copy of a node<a name="line.1595"></a>
<FONT color="green">1596</FONT>         * hierarchy.<a name="line.1596"></a>
<FONT color="green">1597</FONT>         */<a name="line.1597"></a>
<FONT color="green">1598</FONT>        static class CloneVisitor extends ConfigurationNodeVisitorAdapter<a name="line.1598"></a>
<FONT color="green">1599</FONT>        {<a name="line.1599"></a>
<FONT color="green">1600</FONT>            /** A stack with the actual object to be copied. */<a name="line.1600"></a>
<FONT color="green">1601</FONT>            private Stack&lt;ConfigurationNode&gt; copyStack;<a name="line.1601"></a>
<FONT color="green">1602</FONT>    <a name="line.1602"></a>
<FONT color="green">1603</FONT>            /** Stores the result of the clone process. */<a name="line.1603"></a>
<FONT color="green">1604</FONT>            private ConfigurationNode result;<a name="line.1604"></a>
<FONT color="green">1605</FONT>    <a name="line.1605"></a>
<FONT color="green">1606</FONT>            /**<a name="line.1606"></a>
<FONT color="green">1607</FONT>             * Creates a new instance of {@code CloneVisitor}.<a name="line.1607"></a>
<FONT color="green">1608</FONT>             */<a name="line.1608"></a>
<FONT color="green">1609</FONT>            public CloneVisitor()<a name="line.1609"></a>
<FONT color="green">1610</FONT>            {<a name="line.1610"></a>
<FONT color="green">1611</FONT>                copyStack = new Stack&lt;ConfigurationNode&gt;();<a name="line.1611"></a>
<FONT color="green">1612</FONT>            }<a name="line.1612"></a>
<FONT color="green">1613</FONT>    <a name="line.1613"></a>
<FONT color="green">1614</FONT>            /**<a name="line.1614"></a>
<FONT color="green">1615</FONT>             * Visits the specified node after its children have been processed.<a name="line.1615"></a>
<FONT color="green">1616</FONT>             *<a name="line.1616"></a>
<FONT color="green">1617</FONT>             * @param node the node<a name="line.1617"></a>
<FONT color="green">1618</FONT>             */<a name="line.1618"></a>
<FONT color="green">1619</FONT>            @Override<a name="line.1619"></a>
<FONT color="green">1620</FONT>            public void visitAfterChildren(ConfigurationNode node)<a name="line.1620"></a>
<FONT color="green">1621</FONT>            {<a name="line.1621"></a>
<FONT color="green">1622</FONT>                ConfigurationNode copy = copyStack.pop();<a name="line.1622"></a>
<FONT color="green">1623</FONT>                if (copyStack.isEmpty())<a name="line.1623"></a>
<FONT color="green">1624</FONT>                {<a name="line.1624"></a>
<FONT color="green">1625</FONT>                    result = copy;<a name="line.1625"></a>
<FONT color="green">1626</FONT>                }<a name="line.1626"></a>
<FONT color="green">1627</FONT>            }<a name="line.1627"></a>
<FONT color="green">1628</FONT>    <a name="line.1628"></a>
<FONT color="green">1629</FONT>            /**<a name="line.1629"></a>
<FONT color="green">1630</FONT>             * Visits and copies the specified node.<a name="line.1630"></a>
<FONT color="green">1631</FONT>             *<a name="line.1631"></a>
<FONT color="green">1632</FONT>             * @param node the node<a name="line.1632"></a>
<FONT color="green">1633</FONT>             */<a name="line.1633"></a>
<FONT color="green">1634</FONT>            @Override<a name="line.1634"></a>
<FONT color="green">1635</FONT>            public void visitBeforeChildren(ConfigurationNode node)<a name="line.1635"></a>
<FONT color="green">1636</FONT>            {<a name="line.1636"></a>
<FONT color="green">1637</FONT>                ConfigurationNode copy = (ConfigurationNode) node.clone();<a name="line.1637"></a>
<FONT color="green">1638</FONT>                copy.setParentNode(null);<a name="line.1638"></a>
<FONT color="green">1639</FONT>    <a name="line.1639"></a>
<FONT color="green">1640</FONT>                if (!copyStack.isEmpty())<a name="line.1640"></a>
<FONT color="green">1641</FONT>                {<a name="line.1641"></a>
<FONT color="green">1642</FONT>                    if (node.isAttribute())<a name="line.1642"></a>
<FONT color="green">1643</FONT>                    {<a name="line.1643"></a>
<FONT color="green">1644</FONT>                        copyStack.peek().addAttribute(copy);<a name="line.1644"></a>
<FONT color="green">1645</FONT>                    }<a name="line.1645"></a>
<FONT color="green">1646</FONT>                    else<a name="line.1646"></a>
<FONT color="green">1647</FONT>                    {<a name="line.1647"></a>
<FONT color="green">1648</FONT>                        copyStack.peek().addChild(copy);<a name="line.1648"></a>
<FONT color="green">1649</FONT>                    }<a name="line.1649"></a>
<FONT color="green">1650</FONT>                }<a name="line.1650"></a>
<FONT color="green">1651</FONT>    <a name="line.1651"></a>
<FONT color="green">1652</FONT>                copyStack.push(copy);<a name="line.1652"></a>
<FONT color="green">1653</FONT>            }<a name="line.1653"></a>
<FONT color="green">1654</FONT>    <a name="line.1654"></a>
<FONT color="green">1655</FONT>            /**<a name="line.1655"></a>
<FONT color="green">1656</FONT>             * Returns the result of the clone process. This is the root node of the<a name="line.1656"></a>
<FONT color="green">1657</FONT>             * cloned node hierarchy.<a name="line.1657"></a>
<FONT color="green">1658</FONT>             *<a name="line.1658"></a>
<FONT color="green">1659</FONT>             * @return the cloned root node<a name="line.1659"></a>
<FONT color="green">1660</FONT>             */<a name="line.1660"></a>
<FONT color="green">1661</FONT>            public ConfigurationNode getClone()<a name="line.1661"></a>
<FONT color="green">1662</FONT>            {<a name="line.1662"></a>
<FONT color="green">1663</FONT>                return result;<a name="line.1663"></a>
<FONT color="green">1664</FONT>            }<a name="line.1664"></a>
<FONT color="green">1665</FONT>        }<a name="line.1665"></a>
<FONT color="green">1666</FONT>    <a name="line.1666"></a>
<FONT color="green">1667</FONT>        /**<a name="line.1667"></a>
<FONT color="green">1668</FONT>         * A specialized visitor base class that can be used for storing the tree of<a name="line.1668"></a>
<FONT color="green">1669</FONT>         * configuration nodes. The basic idea is that each node can be associated<a name="line.1669"></a>
<FONT color="green">1670</FONT>         * with a reference object. This reference object has a concrete meaning in<a name="line.1670"></a>
<FONT color="green">1671</FONT>         * a derived class, e.g. an entry in a JNDI context or an XML element. When<a name="line.1671"></a>
<FONT color="green">1672</FONT>         * the configuration tree is set up, the {@code load()} method is<a name="line.1672"></a>
<FONT color="green">1673</FONT>         * responsible for setting the reference objects. When the configuration<a name="line.1673"></a>
<FONT color="green">1674</FONT>         * tree is later modified, new nodes do not have a defined reference object.<a name="line.1674"></a>
<FONT color="green">1675</FONT>         * This visitor class processes all nodes and finds the ones without a<a name="line.1675"></a>
<FONT color="green">1676</FONT>         * defined reference object. For those nodes the {@code insert()}<a name="line.1676"></a>
<FONT color="green">1677</FONT>         * method is called, which must be defined in concrete sub classes. This<a name="line.1677"></a>
<FONT color="green">1678</FONT>         * method can perform all steps to integrate the new node into the original<a name="line.1678"></a>
<FONT color="green">1679</FONT>         * structure.<a name="line.1679"></a>
<FONT color="green">1680</FONT>         *<a name="line.1680"></a>
<FONT color="green">1681</FONT>         */<a name="line.1681"></a>
<FONT color="green">1682</FONT>        protected abstract static class BuilderVisitor extends NodeVisitor<a name="line.1682"></a>
<FONT color="green">1683</FONT>        {<a name="line.1683"></a>
<FONT color="green">1684</FONT>            /**<a name="line.1684"></a>
<FONT color="green">1685</FONT>             * Visits the specified node before its children have been traversed.<a name="line.1685"></a>
<FONT color="green">1686</FONT>             *<a name="line.1686"></a>
<FONT color="green">1687</FONT>             * @param node the node to visit<a name="line.1687"></a>
<FONT color="green">1688</FONT>             * @param key the current key<a name="line.1688"></a>
<FONT color="green">1689</FONT>             */<a name="line.1689"></a>
<FONT color="green">1690</FONT>            @Override<a name="line.1690"></a>
<FONT color="green">1691</FONT>            public void visitBeforeChildren(Node node, ConfigurationKey key)<a name="line.1691"></a>
<FONT color="green">1692</FONT>            {<a name="line.1692"></a>
<FONT color="green">1693</FONT>                Collection&lt;ConfigurationNode&gt; subNodes = new LinkedList&lt;ConfigurationNode&gt;(node.getChildren());<a name="line.1693"></a>
<FONT color="green">1694</FONT>                subNodes.addAll(node.getAttributes());<a name="line.1694"></a>
<FONT color="green">1695</FONT>                Iterator&lt;ConfigurationNode&gt; children = subNodes.iterator();<a name="line.1695"></a>
<FONT color="green">1696</FONT>                Node sibling1 = null;<a name="line.1696"></a>
<FONT color="green">1697</FONT>                Node nd = null;<a name="line.1697"></a>
<FONT color="green">1698</FONT>    <a name="line.1698"></a>
<FONT color="green">1699</FONT>                while (children.hasNext())<a name="line.1699"></a>
<FONT color="green">1700</FONT>                {<a name="line.1700"></a>
<FONT color="green">1701</FONT>                    // find the next new node<a name="line.1701"></a>
<FONT color="green">1702</FONT>                    do<a name="line.1702"></a>
<FONT color="green">1703</FONT>                    {<a name="line.1703"></a>
<FONT color="green">1704</FONT>                        sibling1 = nd;<a name="line.1704"></a>
<FONT color="green">1705</FONT>                        Object obj = children.next();<a name="line.1705"></a>
<FONT color="green">1706</FONT>                        nd = getNodeFor(obj);<a name="line.1706"></a>
<FONT color="green">1707</FONT>                    } while (nd.getReference() != null &amp;&amp; children.hasNext());<a name="line.1707"></a>
<FONT color="green">1708</FONT>    <a name="line.1708"></a>
<FONT color="green">1709</FONT>                    if (nd.getReference() == null)<a name="line.1709"></a>
<FONT color="green">1710</FONT>                    {<a name="line.1710"></a>
<FONT color="green">1711</FONT>                        // find all following new nodes<a name="line.1711"></a>
<FONT color="green">1712</FONT>                        List&lt;Node&gt; newNodes = new LinkedList&lt;Node&gt;();<a name="line.1712"></a>
<FONT color="green">1713</FONT>                        newNodes.add(nd);<a name="line.1713"></a>
<FONT color="green">1714</FONT>                        while (children.hasNext())<a name="line.1714"></a>
<FONT color="green">1715</FONT>                        {<a name="line.1715"></a>
<FONT color="green">1716</FONT>                            Object obj = children.next();<a name="line.1716"></a>
<FONT color="green">1717</FONT>                            nd = getNodeFor(obj);<a name="line.1717"></a>
<FONT color="green">1718</FONT>                            if (nd.getReference() == null)<a name="line.1718"></a>
<FONT color="green">1719</FONT>                            {<a name="line.1719"></a>
<FONT color="green">1720</FONT>                                newNodes.add(nd);<a name="line.1720"></a>
<FONT color="green">1721</FONT>                            }<a name="line.1721"></a>
<FONT color="green">1722</FONT>                            else<a name="line.1722"></a>
<FONT color="green">1723</FONT>                            {<a name="line.1723"></a>
<FONT color="green">1724</FONT>                                break;<a name="line.1724"></a>
<FONT color="green">1725</FONT>                            }<a name="line.1725"></a>
<FONT color="green">1726</FONT>                        }<a name="line.1726"></a>
<FONT color="green">1727</FONT>    <a name="line.1727"></a>
<FONT color="green">1728</FONT>                        // Insert all new nodes<a name="line.1728"></a>
<FONT color="green">1729</FONT>                        Node sibling2 = (nd.getReference() == null) ? null : nd;<a name="line.1729"></a>
<FONT color="green">1730</FONT>                        for (Node insertNode : newNodes)<a name="line.1730"></a>
<FONT color="green">1731</FONT>                        {<a name="line.1731"></a>
<FONT color="green">1732</FONT>                            if (insertNode.getReference() == null)<a name="line.1732"></a>
<FONT color="green">1733</FONT>                            {<a name="line.1733"></a>
<FONT color="green">1734</FONT>                                Object ref = insert(insertNode, node, sibling1, sibling2);<a name="line.1734"></a>
<FONT color="green">1735</FONT>                                if (ref != null)<a name="line.1735"></a>
<FONT color="green">1736</FONT>                                {<a name="line.1736"></a>
<FONT color="green">1737</FONT>                                    insertNode.setReference(ref);<a name="line.1737"></a>
<FONT color="green">1738</FONT>                                }<a name="line.1738"></a>
<FONT color="green">1739</FONT>                                sibling1 = insertNode;<a name="line.1739"></a>
<FONT color="green">1740</FONT>                            }<a name="line.1740"></a>
<FONT color="green">1741</FONT>                        }<a name="line.1741"></a>
<FONT color="green">1742</FONT>                    }<a name="line.1742"></a>
<FONT color="green">1743</FONT>                }<a name="line.1743"></a>
<FONT color="green">1744</FONT>            }<a name="line.1744"></a>
<FONT color="green">1745</FONT>    <a name="line.1745"></a>
<FONT color="green">1746</FONT>            /**<a name="line.1746"></a>
<FONT color="green">1747</FONT>             * Inserts a new node into the structure constructed by this builder.<a name="line.1747"></a>
<FONT color="green">1748</FONT>             * This method is called for each node that has been added to the<a name="line.1748"></a>
<FONT color="green">1749</FONT>             * configuration tree after the configuration has been loaded from its<a name="line.1749"></a>
<FONT color="green">1750</FONT>             * source. These new nodes have to be inserted into the original<a name="line.1750"></a>
<FONT color="green">1751</FONT>             * structure. The passed in nodes define the position of the node to be<a name="line.1751"></a>
<FONT color="green">1752</FONT>             * inserted: its parent and the siblings between to insert. The return<a name="line.1752"></a>
<FONT color="green">1753</FONT>             * value is interpreted as the new reference of the affected<a name="line.1753"></a>
<FONT color="green">1754</FONT>             * {@code Node} object; if it is not &lt;b&gt;null &lt;/b&gt;, it is passed<a name="line.1754"></a>
<FONT color="green">1755</FONT>             * to the node's {@code setReference()} method.<a name="line.1755"></a>
<FONT color="green">1756</FONT>             *<a name="line.1756"></a>
<FONT color="green">1757</FONT>             * @param newNode the node to be inserted<a name="line.1757"></a>
<FONT color="green">1758</FONT>             * @param parent the parent node<a name="line.1758"></a>
<FONT color="green">1759</FONT>             * @param sibling1 the sibling after which the node is to be inserted;<a name="line.1759"></a>
<FONT color="green">1760</FONT>             * can be &lt;b&gt;null &lt;/b&gt; if the new node is going to be the first child<a name="line.1760"></a>
<FONT color="green">1761</FONT>             * node<a name="line.1761"></a>
<FONT color="green">1762</FONT>             * @param sibling2 the sibling before which the node is to be inserted;<a name="line.1762"></a>
<FONT color="green">1763</FONT>             * can be &lt;b&gt;null &lt;/b&gt; if the new node is going to be the last child<a name="line.1763"></a>
<FONT color="green">1764</FONT>             * node<a name="line.1764"></a>
<FONT color="green">1765</FONT>             * @return the reference object for the node to be inserted<a name="line.1765"></a>
<FONT color="green">1766</FONT>             */<a name="line.1766"></a>
<FONT color="green">1767</FONT>            protected abstract Object insert(Node newNode, Node parent, Node sibling1, Node sibling2);<a name="line.1767"></a>
<FONT color="green">1768</FONT>        }<a name="line.1768"></a>
<FONT color="green">1769</FONT>    }<a name="line.1769"></a>




























































</PRE>
</BODY>
</HTML>
